{ "openapi": "3.2.0", "info": { "title": "seg-config-api", "description": "API Gateway that provides a single point of entry for clients to manage customer configuration.", "version": "1.2.1" }, "paths": { "/seg/config/v1/beta/{customerId}/directory/domains": { "get": { "tags": [ "domains" ], "summary": "Get Domains", "operationId": "get_domains_api_v1_seg_config_gateway__customerId__directory_domains_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search only for domains that prefix the given filter", "title": "Filter" }, "description": "Search only for domains that prefix the given filter" }, { "name": "order", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Order", "description": "Defines the order in which the domains appear in the response", "default": "ascending" }, "description": "Defines the order in which the domains appear in the response" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Result size", "default": 1000, "title": "Limit" }, "description": "Result size" }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for pagination", "title": "Cursor" }, "description": "Cursor for pagination" }, { "name": "detailed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Return detailed information", "default": false, "title": "Detailed" }, "description": "Return detailed information" } ], "responses": { "200": { "description": "Get all domains of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_list_TransportTypeDomainWithDetails__" }, "examples": { "detailed=false": { "summary": "detailed = false", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "detailed": false, "filter": "example-filter", "order": "example-order", "nextCursor": "example-next-cursor", "prevCursor": "example-prev-cursor", "limit": 10, "rid": "example-rid" }, "result": [ { "domain": "example1.test" }, { "domain": "example2.test" } ] } }, "detailed=true": { "summary": "detailed = true", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "detailed": true, "filter": "example-filter", "order": "example-order", "nextCursor": "example-next-cursor", "prevCursor": "example-prev-cursor", "limit": 10, "rid": "example-rid" }, "result": [ { "domain": "example1.test", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } }, { "domain": "example2.test", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } } ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "domains" ], "summary": "Put Domains", "operationId": "put_domains_api_v1_seg_config_gateway__customerId__directory_domains_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadDomainsPutPatch", "examples": [ { "comment": "Example comment", "domains": [ { "domain": "example1.test", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } }, { "domain": "example2.test", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } } ] } ] } } } }, "responses": { "200": { "description": "Add multiple domains to a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "success": { "summary": "Successfully added all domains", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated domains" } }, "partialSuccess": { "summary": "Partially successful update", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful domains update", "unsuccessful": [ "example.test" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "domains" ], "summary": "Patch Domains", "operationId": "patch_domains_api_v1_seg_config_gateway__customerId__directory_domains_patch", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadDomainsPutPatch", "examples": [ { "comment": "Example comment", "domains": [ { "domain": "example1.test", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } }, { "domain": "example2.test", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } } ] } ] } } } }, "responses": { "200": { "description": "Update multiple domains of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "success": { "summary": "Successfully updated all domains", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully patched domains" } }, "partialSuccess": { "summary": "Partially successful update", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful domains patch", "unsuccessful": [ "example.test" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "domains" ], "summary": "Delete Domains", "operationId": "delete_domains_api_v1_seg_config_gateway__customerId__directory_domains_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadDomainsDelete", "examples": [ { "domains": [ "example1.test", "example2.test" ] } ] } } } }, "responses": { "200": { "description": "Delete multiple domains of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "success": { "summary": "Successfully deleted all domains", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted domains" } }, "partialSuccess": { "summary": "Partially successful delete", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful domains delete", "unsuccessful": [ "example.test" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}": { "get": { "tags": [ "domains" ], "summary": "Get Single Domain", "operationId": "get_single_domain_api_v1_seg_config_gateway__customerId__directory_domains__domain__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "responses": { "200": { "description": "Get a single domain of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_TransportTypeDomainDetails_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": { "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "domains" ], "summary": "Put Single Domain", "operationId": "put_single_domain_api_v1_seg_config_gateway__customerId__directory_domains__domain__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadSingleDomainPutPatch", "examples": [ { "comment": "Example comment", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } } ] } } } }, "responses": { "200": { "description": "Add a single domain to a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated domain" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "domains" ], "summary": "Patch Single Domain", "operationId": "patch_single_domain_api_v1_seg_config_gateway__customerId__directory_domains__domain__patch", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadSingleDomainPutPatch", "examples": [ { "comment": "Example comment", "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" } } ] } } } }, "responses": { "200": { "description": "Update a single domain of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully patched domain" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "domains" ], "summary": "Delete Single Domain", "operationId": "delete_single_domain_api_v1_seg_config_gateway__customerId__directory_domains__domain__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "responses": { "200": { "description": "Delete a single domain of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted domain" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/users": { "get": { "tags": [ "users" ], "summary": "Get Users", "operationId": "get_users_api_v1_seg_config_gateway__customerId__directory_users_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search only for domains that prefix the given filter", "title": "Filter" }, "description": "Search only for domains that prefix the given filter" }, { "name": "order", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Order", "description": "Defines the order in which the domains appear in the response", "default": "ascending" }, "description": "Defines the order in which the domains appear in the response" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Result size", "default": 1000, "title": "Limit" }, "description": "Result size" }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for pagination", "title": "Cursor" }, "description": "Cursor for pagination" }, { "name": "detailed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Return detailed information", "default": false, "title": "Detailed" }, "description": "Return detailed information" } ], "responses": { "200": { "description": "Get all users of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_list_TransportTypeUserWithDetails__" }, "examples": { "detailed=false": { "summary": "detailed = false", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "detailed": false, "filter": "example-filter", "order": "example-order", "nextCursor": "example-next-cursor", "prevCursor": "example-prev-cursor", "limit": 10, "rid": "example-rid" }, "result": [ { "address": "user1@example.test" }, { "address": "user2@example.test" } ] } }, "detailed=true": { "summary": "detailed = true", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "detailed": true, "filter": "example-filter", "order": "example-order", "nextCursor": "example-next-cursor", "prevCursor": "example-prev-cursor", "limit": 10, "rid": "example-rid" }, "result": [ { "address": "user1@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } }, { "address": "user2@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } } ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/users": { "get": { "tags": [ "users" ], "summary": "Get Domain Users", "operationId": "get_domain_users_api_v1_seg_config_gateway__customerId__directory_domains__domain__users_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "filter", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Search only for domains that prefix the given filter", "title": "Filter" }, "description": "Search only for domains that prefix the given filter" }, { "name": "order", "in": "query", "required": false, "schema": { "$ref": "#/components/schemas/Order", "description": "Defines the order in which the domains appear in the response", "default": "ascending" }, "description": "Defines the order in which the domains appear in the response" }, { "name": "limit", "in": "query", "required": false, "schema": { "type": "integer", "minimum": 0, "description": "Result size", "default": 1000, "title": "Limit" }, "description": "Result size" }, { "name": "cursor", "in": "query", "required": false, "schema": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "description": "Cursor for pagination", "title": "Cursor" }, "description": "Cursor for pagination" }, { "name": "detailed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Return detailed information", "default": false, "title": "Detailed" }, "description": "Return detailed information" } ], "responses": { "200": { "description": "Get all users of a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_list_TransportTypeUserWithDetails__" }, "examples": { "detailed=false": { "summary": "detailed = false", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "detailed": false, "filter": "example-filter", "order": "example-order", "nextCursor": "example-next-cursor", "prevCursor": "example-prev-cursor", "limit": 10, "rid": "example-rid" }, "result": [ { "address": "user1@example.test" }, { "address": "user2@example.test" } ] } }, "detailed=true": { "summary": "detailed = true", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "detailed": true, "filter": "example-filter", "order": "example-order", "nextCursor": "example-next-cursor", "prevCursor": "example-prev-cursor", "limit": 10, "rid": "example-rid" }, "result": [ { "address": "user1@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } }, { "address": "user2@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } } ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "users" ], "summary": "Put Domain Users", "operationId": "put_domain_users_api_v1_seg_config_gateway__customerId__directory_domains__domain__users_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadUsersPutPatch", "examples": [ { "comment": "Example comment", "users": [ { "address": "user1@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } }, { "address": "user2@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } } ] } ] } } } }, "responses": { "200": { "description": "Add a list of users to a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "successful": { "summary": "Successfully added all users", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated users" } }, "partiallySuccessful": { "summary": "Partially successful update", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful users update", "unsuccessful": [ "user@example.test" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Patch Domain Users", "operationId": "patch_domain_users_api_v1_seg_config_gateway__customerId__directory_domains__domain__users_patch", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadUsersPutPatch", "examples": [ { "comment": "Example comment", "users": [ { "address": "user1@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } }, { "address": "user2@example.test", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } } ] } ] } } } }, "responses": { "200": { "description": "Update a list of users of a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "successful": { "summary": "Successfully updated all users", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully patched users" } }, "partiallySuccessful": { "summary": "Partially successful update", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful users patch", "unsuccessful": [ "user@example.test" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "users" ], "summary": "Delete Domain Users", "operationId": "delete_domain_users_api_v1_seg_config_gateway__customerId__directory_domains__domain__users_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadUsersDelete", "examples": [ { "addresses": [ "user1@example.test", "user2@example.test" ] } ] } } } }, "responses": { "200": { "description": "Delete a list of users of a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "success": { "summary": "Successfully deleted all users", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted users" } }, "partialSuccess": { "summary": "Partially successful delete", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful users delete", "unsuccessful": [ "user@example.test" ] } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/users/{user}": { "get": { "tags": [ "users" ], "summary": "Get Domain Single User", "operationId": "get_domain_single_user_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Get a single user of a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_TransportTypeUserDetails_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "user": "user@example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": { "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "users" ], "summary": "Put Domain Single User", "operationId": "put_domain_single_user_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadSingleUserPutPatch", "examples": [ { "comment": "Example comment", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } } ] } } } }, "responses": { "200": { "description": "Add a single user to a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated user" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "users" ], "summary": "Patch Domain Single User", "operationId": "patch_domain_single_user_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__patch", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadSingleUserPutPatch", "examples": [ { "comment": "Example comment", "aliases": [ "example.alias1", "example.alias2" ], "rewrite": { "inbound": "example.rewrite.inbound", "outbound": "example.rewrite.outbound" }, "relay": { "inbound": "example.relay.inbound", "outbound": "example.relay.outbound" } } ] } } } }, "responses": { "200": { "description": "Update a single user of a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully patched user" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "users" ], "summary": "Delete Domain Single User", "operationId": "delete_domain_single_user_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Delete a single user of a customer for a specific domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted user" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/relays": { "get": { "tags": [ "relaySetup" ], "summary": "Get Relays", "operationId": "get_relays_api_v1_seg_config_gateway__customerId__relays_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "detailed", "in": "query", "required": false, "schema": { "type": "boolean", "description": "Whether to include relay details", "default": false, "title": "Detailed" }, "description": "Whether to include relay details" } ], "responses": { "200": { "description": "Get all relays of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_list_TransportTypeGetPatchRelayWithDetails__" }, "examples": { "detailed=false": { "summary": "detailed = false", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "detailed": false, "rid": "example-rid" }, "result": [ { "relayId": "example.relay1" }, { "relayId": "example.relay2" } ] } }, "detailed=true": { "summary": "detailed = true", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "detailed": true, "rid": "example-rid" }, "result": [ { "relayId": "example.relay1", "target": "example.relay", "type": "mx" }, { "relayId": "example.relay2", "target": "example.relay", "type": "mx" } ] } } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "relaySetup" ], "summary": "Put Relays", "operationId": "put_relays_api_v1_seg_config_gateway__customerId__relays_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRelaysPut", "examples": [ { "comment": "Example comment", "relays": [ { "relayId": "example.relay1", "target": "example.relay", "type": "mx" }, { "relayId": "example.relay2", "target": "example.relay", "type": "mx" } ] } ] } } } }, "responses": { "200": { "description": "Add multiple relays to a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "successful": { "summary": "Successfully added all relays", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated relays" } }, "partiallySuccessful": { "summary": "Partially successful update", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful relays update" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "patch": { "tags": [ "relaySetup" ], "summary": "Patch Relays", "operationId": "patch_relays_api_v1_seg_config_gateway__customerId__relays_patch", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRelaysPatch", "examples": [ { "comment": "Example comment", "relays": [ { "relayId": "example.relay1", "target": "example.relay", "type": "mx" }, { "relayId": "example.relay2", "target": "example.relay", "type": "mx" } ] } ] } } } }, "responses": { "200": { "description": "Update multiple relays of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "examples": { "successful": { "summary": "Successfully updated all relays", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully patched relays" } }, "partiallySuccessful": { "summary": "Partially successful update", "value": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Partially successful relays patch" } } } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "relaySetup" ], "summary": "Delete Relays", "operationId": "delete_relays_api_v1_seg_config_gateway__customerId__relays_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRelaysDelete", "examples": [ { "relayIds": [ "example.relay1", "example.relay2" ] } ] } } } }, "responses": { "200": { "description": "Delete multiple relays of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted relays" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/relays/{relayId}": { "get": { "tags": [ "relaySetup" ], "summary": "Get Single Relay", "operationId": "get_single_relay_api_v1_seg_config_gateway__customerId__relays__relayId__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "relayId", "in": "path", "required": true, "schema": { "type": "string", "title": "Relayid" } } ], "responses": { "200": { "description": "Get a single relay of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_TransportTypeRelayDetails_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": { "target": "example.relay", "type": "mx" } } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "relaySetup" ], "summary": "Put Single Relay", "operationId": "put_single_relay_api_v1_seg_config_gateway__customerId__relays__relayId__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "relayId", "in": "path", "required": true, "schema": { "type": "string", "title": "Relayid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadSingleRelayPutPatch", "examples": [ { "comment": "Example comment", "target": "example.relay", "type": "mx" } ] } } } }, "responses": { "200": { "description": "Add a single relay to a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated relay" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 400, "message": "Something failed" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "relaySetup" ], "summary": "Delete Single Relay", "operationId": "delete_single_relay_api_v1_seg_config_gateway__customerId__relays__relayId__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "relayId", "in": "path", "required": true, "schema": { "type": "string", "title": "Relayid" } } ], "responses": { "200": { "description": "Delete a single relay of a customer", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted relay" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/rewrite/inbound": { "get": { "tags": [ "rewriteManagement" ], "summary": "Get Domain Rewrite Inbound", "operationId": "get_domain_rewrite_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__rewrite_inbound_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "responses": { "200": { "description": "Get inbound rewrite for a domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_str_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": "example.rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "rewriteManagement" ], "summary": "Put Domain Rewrite Inbound", "operationId": "put_domain_rewrite_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__rewrite_inbound_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRewritePut", "examples": [ { "comment": "Example comment", "target": "example.rewrite" } ] } } } }, "responses": { "200": { "description": "Add inbound rewrite for a domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated inbound domain rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "rewriteManagement" ], "summary": "Delete Domain Rewrite Inbound", "operationId": "delete_domain_rewrite_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__rewrite_inbound_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "responses": { "200": { "description": "Delete inbound rewrite for a domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted inbound domain rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/rewrite/outbound": { "get": { "tags": [ "rewriteManagement" ], "summary": "Get Domain Rewrite Outbound", "operationId": "get_domain_rewrite_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__rewrite_outbound_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "responses": { "200": { "description": "Get outbound rewrite for a domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_str_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": "example.rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "rewriteManagement" ], "summary": "Put Domain Rewrite Outbound", "operationId": "put_domain_rewrite_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__rewrite_outbound_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRewritePut", "examples": [ { "comment": "Example comment", "target": "example.rewrite" } ] } } } }, "responses": { "200": { "description": "Add outbound rewrite for a domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated outbound domain rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "rewriteManagement" ], "summary": "Delete Domain Rewrite Outbound", "operationId": "delete_domain_rewrite_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__rewrite_outbound_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } } ], "responses": { "200": { "description": "Delete outbound rewrite for a domain", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted outbound domain rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/users/{user}/rewrite/inbound": { "get": { "tags": [ "rewriteManagement" ], "summary": "Get User Rewrite Inbound", "operationId": "get_user_rewrite_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__rewrite_inbound_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Get inbound rewrite for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_str_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "user": "user@example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": "example.rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "rewriteManagement" ], "summary": "Put User Rewrite Inbound", "operationId": "put_user_rewrite_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__rewrite_inbound_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRewritePut", "examples": [ { "comment": "Example comment", "target": "example.rewrite" } ] } } } }, "responses": { "200": { "description": "Add inbound rewrite for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated inbound user rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "rewriteManagement" ], "summary": "Delete User Rewrite Inbound", "operationId": "delete_user_rewrite_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__rewrite_inbound_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Delete inbound rewrite for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted inbound user rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/users/{user}/rewrite/outbound": { "get": { "tags": [ "rewriteManagement" ], "summary": "Get User Rewrite Outbound", "operationId": "get_user_rewrite_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__rewrite_outbound_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Get outbound rewrite for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_str_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "user": "user@example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": "example.rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "rewriteManagement" ], "summary": "Put User Rewrite Outbound", "operationId": "put_user_rewrite_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__rewrite_outbound_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRewritePut", "examples": [ { "comment": "Example comment", "target": "example.rewrite" } ] } } } }, "responses": { "200": { "description": "Add outbound rewrite for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated outbound user rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "rewriteManagement" ], "summary": "Delete User Rewrite Outbound", "operationId": "delete_user_rewrite_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__rewrite_outbound_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Delete outbound rewrite for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted outbound user rewrite" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/users/{user}/relay/inbound": { "get": { "tags": [ "relayManagement" ], "summary": "Get User Relay Inbound", "operationId": "get_user_relay_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__relay_inbound_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Get inbound relay for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_str_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "user": "user@example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": "example.relay" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "relayManagement" ], "summary": "Put User Relay Inbound", "operationId": "put_user_relay_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__relay_inbound_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRelayPut", "examples": [ { "comment": "Example comment", "relayId": "example.relay" } ] } } } }, "responses": { "200": { "description": "Add inbound relay for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated inbound user relay" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "relayManagement" ], "summary": "Delete User Relay Inbound", "operationId": "delete_user_relay_inbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__relay_inbound_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Delete inbound relay for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted inbound user relay" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/users/{user}/relay/outbound": { "get": { "tags": [ "relayManagement" ], "summary": "Get User Relay Outbound", "operationId": "get_user_relay_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__relay_outbound_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Get outbound relay for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_str_" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "user": "user@example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": "example.relay" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "relayManagement" ], "summary": "Put User Relay Outbound", "operationId": "put_user_relay_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__relay_outbound_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadRelayPut", "examples": [ { "comment": "Example comment", "relayId": "example.relay" } ] } } } }, "responses": { "200": { "description": "Add outbound relay for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated outbound user relay" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "relayManagement" ], "summary": "Delete User Relay Outbound", "operationId": "delete_user_relay_outbound_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__relay_outbound_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Delete outbound relay for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted outbound user relay" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/directory/domains/{domain}/users/{user}/aliases": { "get": { "tags": [ "aliasManagement" ], "summary": "Get User Aliases", "operationId": "get_user_aliases_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__aliases_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Get aliases for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponseGet_list_str__" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "metadata": { "customer": "44444", "domain": "example.test", "user": "user@example.test", "lastModifiedBy": "user@example.test", "lastModifiedAt": "2026-01-01T00:00:00.000Z", "comment": "Example comment", "rid": "example-rid" }, "result": [ "example.alias1", "example.alias2" ] } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "put": { "tags": [ "aliasManagement" ], "summary": "Put User Aliases", "operationId": "put_user_aliases_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__aliases_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportPayloadAliasesPut", "examples": [ { "comment": "Example comment", "aliases": [ "example.alias1", "example.alias2" ] } ] } } } }, "responses": { "200": { "description": "Add aliases for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully updated user aliases" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } }, "delete": { "tags": [ "aliasManagement" ], "summary": "Delete User Aliases", "operationId": "delete_user_aliases_api_v1_seg_config_gateway__customerId__directory_domains__domain__users__user__aliases_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "domain", "in": "path", "required": true, "schema": { "type": "string", "title": "Domain" } }, { "name": "user", "in": "path", "required": true, "schema": { "type": "string", "title": "User" } } ], "responses": { "200": { "description": "Delete aliases for a user", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/TransportResponsePutPatchDelete" }, "example": { "timestamp": "2026-01-01T00:00:00.000Z", "message": "Successfully deleted user aliases" } } } }, "404": { "description": "Not Found", "content": { "application/json": { "example": { "timestamp": "2026-01-01T00:00:00.000Z", "code": 404, "message": "Some entity was not found" }, "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } }, "500": { "description": "Internal Server Error", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } } } } } }, "/seg/config/v1/beta/{customerId}/phishing-detection/{listType}": { "get": { "tags": [ "phishingUrls" ], "summary": "Read Phishing List", "operationId": "read_phishing_list_api_v1_seg_config_gateway__customerId__phishing_detection__listType__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypePhishing" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Phishing list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "url": [ "https://example.com" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "phishingUrls" ], "summary": "Update Phishing Entries", "operationId": "update_phishing_entries_api_v1_seg_config_gateway__customerId__phishing_detection__listType__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyPhishing" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "phishingUrls" ], "summary": "Delete Phishing Entries", "operationId": "delete_phishing_entries_api_v1_seg_config_gateway__customerId__phishing_detection__listType__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyPhishing" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/phishing-detection/{listType}/enabled": { "get": { "tags": [ "phishingUrls" ], "summary": "Get Phishing List Status", "operationId": "get_phishing_list_status_api_v1_seg_config_gateway__customerId__phishing_detection__listType__enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "phishingUrls" ], "summary": "Enable Phishing List", "operationId": "enable_phishing_list_api_v1_seg_config_gateway__customerId__phishing_detection__listType__enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "phishingUrls" ], "summary": "Disable Phishing List", "operationId": "disable_phishing_list_api_v1_seg_config_gateway__customerId__phishing_detection__listType__enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/cxo-fraud-detection/{listType}": { "get": { "tags": [ "cxoFraud" ], "summary": "Read Cxo List", "operationId": "read_cxo_list_api_v1_seg_config_gateway__customerId__cxo_fraud_detection__listType__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeCxo" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseGet" }, "examples": { "sample": { "summary": "Cxo-fraud list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "domain": [ "example.test" ], "address": [ "user@example.test" ] } } } } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "cxoFraud" ], "summary": "Update Cxo Fraud Entries", "operationId": "update_cxo_fraud_entries_api_v1_seg_config_gateway__customerId__cxo_fraud_detection__listType__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyCxo" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "cxoFraud" ], "summary": "Delete Cxo Fraud Entries", "operationId": "delete_cxo_fraud_entries_api_v1_seg_config_gateway__customerId__cxo_fraud_detection__listType__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyCxo" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/cxo-fraud-detection/{listType}/enabled": { "get": { "tags": [ "cxoFraud" ], "summary": "Get Cxo Fraud List Status", "operationId": "get_cxo_fraud_list_status_api_v1_seg_config_gateway__customerId__cxo_fraud_detection__listType__enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "cxoFraud" ], "summary": "Enable Cxo Fraud List", "operationId": "enable_cxo_fraud_list_api_v1_seg_config_gateway__customerId__cxo_fraud_detection__listType__enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "cxoFraud" ], "summary": "Disable Cxo Fraud List", "operationId": "disable_cxo_fraud_list_api_v1_seg_config_gateway__customerId__cxo_fraud_detection__listType__enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/antispam/{listType}/customer": { "get": { "tags": [ "antispamCustomer" ], "summary": "Read Antispam Customer List", "operationId": "read_antispam_customer_list_api_v1_seg_config_gateway__customerId__antispam__listType__customer_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeAntispam" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Antispam list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "address": [ "user@example.test" ], "ip": [ "192.168.0.1" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "antispamCustomer" ], "summary": "Update Antispam Customer Entries", "operationId": "update_antispam_customer_entries_api_v1_seg_config_gateway__customerId__antispam__listType__customer_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyAntispam" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "antispamCustomer" ], "summary": "Delete Antispam Customer Entries", "operationId": "delete_antispam_customer_entries_api_v1_seg_config_gateway__customerId__antispam__listType__customer_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyAntispam" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/antispam/{listType}/customer/enabled": { "get": { "tags": [ "antispamCustomer" ], "summary": "Get Antispam Customer List Status", "operationId": "get_antispam_customer_list_status_api_v1_seg_config_gateway__customerId__antispam__listType__customer_enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "antispamCustomer" ], "summary": "Update Antispam Customer List Status", "operationId": "update_antispam_customer_list_status_api_v1_seg_config_gateway__customerId__antispam__listType__customer_enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "antispamCustomer" ], "summary": "Disable Antispam Customer List", "operationId": "disable_antispam_customer_list_api_v1_seg_config_gateway__customerId__antispam__listType__customer_enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/antispam/{listType}/profile/{profileId}": { "get": { "tags": [ "antispamProfile" ], "summary": "Read Antispam Profile List", "operationId": "read_antispam_profile_list_api_v1_seg_config_gateway__customerId__antispam__listType__profile__profileId__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "title": "Profileid" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeAntispam" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Antispam list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "address": [ "user@example.test" ], "ip": [ "192.168.0.1" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "antispamProfile" ], "summary": "Update Antispam Profile Entries", "operationId": "update_antispam_profile_entries_api_v1_seg_config_gateway__customerId__antispam__listType__profile__profileId__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "title": "Profileid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyAntispam" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "antispamProfile" ], "summary": "Delete Antispam Profile Entries", "operationId": "delete_antispam_profile_entries_api_v1_seg_config_gateway__customerId__antispam__listType__profile__profileId__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "title": "Profileid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyAntispam" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/antispam/{listType}/profile/{profileId}/enabled": { "get": { "tags": [ "antispamProfile" ], "summary": "Get Antispam Profile List Status", "operationId": "get_antispam_profile_list_status_api_v1_seg_config_gateway__customerId__antispam__listType__profile__profileId__enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "title": "Profileid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "antispamProfile" ], "summary": "Enable Antispam Profile List", "operationId": "enable_antispam_profile_list_api_v1_seg_config_gateway__customerId__antispam__listType__profile__profileId__enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "title": "Profileid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "antispamProfile" ], "summary": "Disable Antispam Profile List", "operationId": "disable_antispam_profile_list_api_v1_seg_config_gateway__customerId__antispam__listType__profile__profileId__enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "profileId", "in": "path", "required": true, "schema": { "type": "string", "title": "Profileid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/antispam/{listType}/user/{userName}": { "get": { "tags": [ "antispamUser" ], "summary": "Read Antispam User List", "operationId": "read_antispam_user_list_api_v1_seg_config_gateway__customerId__antispam__listType__user__userName__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "userName", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeAntispam" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Antispam list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "address": [ "user@example.test" ], "ip": [ "192.168.0.1" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "antispamUser" ], "summary": "Update Antispam User Entries", "operationId": "update_antispam_user_entries_api_v1_seg_config_gateway__customerId__antispam__listType__user__userName__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "userName", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyAntispam" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "antispamUser" ], "summary": "Delete Antispam User Entries", "operationId": "delete_antispam_user_entries_api_v1_seg_config_gateway__customerId__antispam__listType__user__userName__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "userName", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyAntispam" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/antispam/{listType}/user/{userName}/enabled": { "get": { "tags": [ "antispamUser" ], "summary": "Get Antispam User List Status", "operationId": "get_antispam_user_list_status_api_v1_seg_config_gateway__customerId__antispam__listType__user__userName__enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "userName", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "antispamUser" ], "summary": "Enable Antispam User List", "operationId": "enable_antispam_user_list_api_v1_seg_config_gateway__customerId__antispam__listType__user__userName__enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "userName", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "antispamUser" ], "summary": "Disable Antispam User List", "operationId": "disable_antispam_user_list_api_v1_seg_config_gateway__customerId__antispam__listType__user__userName__enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "userName", "in": "path", "required": true, "schema": { "type": "string", "title": "Username" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/url-rewrite/{listType}": { "get": { "tags": [ "urlRewriteTimeOfClick" ], "summary": "Read Url Rewrite List", "operationId": "read_url_rewrite_list_api_v1_seg_config_gateway__customerId__url_rewrite__listType__get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeUrlRewrite" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseGet" }, "examples": { "sample": { "summary": "Phishing list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "url": [ "https://example.com" ] } } } } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "urlRewriteTimeOfClick" ], "summary": "Update Url Rewrite List", "operationId": "update_url_rewrite_list_api_v1_seg_config_gateway__customerId__url_rewrite__listType__put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyUrlRewrite" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "urlRewriteTimeOfClick" ], "summary": "Delete Url Rewrite List", "operationId": "delete_url_rewrite_list_api_v1_seg_config_gateway__customerId__url_rewrite__listType__delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyUrlRewrite" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/url-rewrite/{listType}/enabled": { "get": { "tags": [ "urlRewriteTimeOfClick" ], "summary": "Get Url Rewrite List Status", "operationId": "get_url_rewrite_list_status_api_v1_seg_config_gateway__customerId__url_rewrite__listType__enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "urlRewriteTimeOfClick" ], "summary": "Enable Url Rewrite List", "operationId": "enable_url_rewrite_list_api_v1_seg_config_gateway__customerId__url_rewrite__listType__enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "urlRewriteTimeOfClick" ], "summary": "Disable Url Rewrite List", "operationId": "disable_url_rewrite_list_api_v1_seg_config_gateway__customerId__url_rewrite__listType__enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "listType", "in": "path", "required": true, "schema": { "$ref": "#/components/schemas/ListType" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/sender-restriction/inbound/blocklist": { "get": { "tags": [ "inboundSenderRestriction" ], "summary": "Get Inbound Sender Restriction Blocklist", "operationId": "get_inbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_inbound_blocklist_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeSenderRestriction" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Sender-Restriction list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "domain": [ "example.test" ], "address": [ "user@example.test" ], "ip": [ "192.168.0.1" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "inboundSenderRestriction" ], "summary": "Update Inbound Sender Restriction Blocklist", "operationId": "update_inbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_inbound_blocklist_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodySenderRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "inboundSenderRestriction" ], "summary": "Delete Inbound Sender Restriction Blocklist", "operationId": "delete_inbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_inbound_blocklist_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodySenderRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/sender-restriction/inbound/blocklist/enabled": { "get": { "tags": [ "inboundSenderRestriction" ], "summary": "Get Inbound Sender Restriction Blocklist Status", "operationId": "get_inbound_sender_restriction_blocklist_status_api_v1_seg_config_gateway__customerId__sender_restriction_inbound_blocklist_enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "inboundSenderRestriction" ], "summary": "Enable Inbound Sender Restriction Blocklist", "operationId": "enable_inbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_inbound_blocklist_enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "inboundSenderRestriction" ], "summary": "Disable Inbound Sender Restriction Blocklist", "operationId": "disable_inbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_inbound_blocklist_enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/sender-restriction/outbound/allowlist": { "get": { "tags": [ "outboundSenderRestrictionAllowlist" ], "summary": "Get Outbound Sender Restriction Allowlist Entries", "operationId": "get_outbound_sender_restriction_allowlist_entries_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_allowlist_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeSenderRestriction" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Sender-Restriction list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "domain": [ "example.test" ], "address": [ "user@example.test" ], "ip": [ "192.168.0.1" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "outboundSenderRestrictionAllowlist" ], "summary": "Update Outbound Sender Restriction Allowlist Entries", "operationId": "update_outbound_sender_restriction_allowlist_entries_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_allowlist_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodySenderRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "outboundSenderRestrictionAllowlist" ], "summary": "Delete Outbound Sender Restriction Allowlist Entries", "operationId": "delete_outbound_sender_restriction_allowlist_entries_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_allowlist_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodySenderRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/sender-restriction/outbound/allowlist/enabled": { "get": { "tags": [ "outboundSenderRestrictionAllowlist" ], "summary": "Get Outbound Sender Restriction Allowlist Status", "operationId": "get_outbound_sender_restriction_allowlist_status_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_allowlist_enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "outboundSenderRestrictionAllowlist" ], "summary": "Enable Outbound Sender Restriction Allowlist", "operationId": "enable_outbound_sender_restriction_allowlist_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_allowlist_enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "outboundSenderRestrictionAllowlist" ], "summary": "Disable Outbound Sender Restriction Allowlist", "operationId": "disable_outbound_sender_restriction_allowlist_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_allowlist_enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/sender-restriction/outbound/blocklist": { "get": { "tags": [ "outboundSenderRestrictionBlocklist" ], "summary": "Get Outbound Sender Restriction Blocklist", "operationId": "get_outbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_blocklist_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeSenderRestriction" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Sender-Restriction list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "domain": [ "example.test" ], "address": [ "user@example.test" ], "ip": [ "192.168.0.1" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "outboundSenderRestrictionBlocklist" ], "summary": "Update Outbound Sender Restriction Blocklist", "operationId": "update_outbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_blocklist_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodySenderRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "outboundSenderRestrictionBlocklist" ], "summary": "Delete Outbound Sender Restriction Blocklist", "operationId": "delete_outbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_blocklist_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodySenderRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/sender-restriction/outbound/blocklist/enabled": { "get": { "tags": [ "outboundSenderRestrictionBlocklist" ], "summary": "Get Outbound Sender Restriction Blocklist Status", "operationId": "get_outbound_sender_restriction_blocklist_status_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_blocklist_enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "outboundSenderRestrictionBlocklist" ], "summary": "Enable Outbound Sender Restriction Blocklist", "operationId": "enable_outbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_blocklist_enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "outboundSenderRestrictionBlocklist" ], "summary": "Disable Outbound Sender Restriction Blocklist", "operationId": "disable_outbound_sender_restriction_blocklist_api_v1_seg_config_gateway__customerId__sender_restriction_outbound_blocklist_enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/recipient-restriction/inbound/blocklist": { "get": { "tags": [ "inboundRecipientRestriction" ], "summary": "Get Inbound Recipient Restriction Blocklist", "operationId": "get_inbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_inbound_blocklist_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeRecipientRestriction" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Recipient-Restriction list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "domain": [ "example.test" ], "address": [ "user@example.test" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "inboundRecipientRestriction" ], "summary": "Update Inbound Recipient Restriction Blocklist", "operationId": "update_inbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_inbound_blocklist_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyRecipientRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "inboundRecipientRestriction" ], "summary": "Delete Inbound Recipient Restriction Blocklist", "operationId": "delete_inbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_inbound_blocklist_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyRecipientRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/recipient-restriction/inbound/blocklist/enabled": { "get": { "tags": [ "inboundRecipientRestriction" ], "summary": "Get Inbound Recipient Restriction Blocklist Status", "operationId": "get_inbound_recipient_restriction_blocklist_status_api_v1_seg_config_gateway__customerId__recipient_restriction_inbound_blocklist_enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "inboundRecipientRestriction" ], "summary": "Enable Inbound Recipient Restriction Blocklist", "operationId": "enable_inbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_inbound_blocklist_enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "inboundRecipientRestriction" ], "summary": "Disable Inbound Recipient Restriction Blocklist", "operationId": "disable_inbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_inbound_blocklist_enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/recipient-restriction/outbound/blocklist": { "get": { "tags": [ "outboundRecipientRestriction" ], "summary": "Get Outbound Recipient Restriction Blocklist", "operationId": "get_outbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_outbound_blocklist_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } }, { "name": "type", "in": "query", "required": false, "schema": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypeRecipientRestriction" }, { "type": "null" } ], "title": "Type" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "examples": { "sample": { "summary": "Recipient-Restriction list response", "value": { "lastModifiedTs": "2026-01-01T00:00:00.000Z", "lastModifiedBy": "user@example.test", "entries": { "domain": [ "example.test" ], "address": [ "user@example.test" ] } } } }, "schema": { "$ref": "#/components/schemas/ListResponseGet" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "outboundRecipientRestriction" ], "summary": "Update Outbound Recipient Restriction Blocklist", "operationId": "update_outbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_outbound_blocklist_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyRecipientRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "outboundRecipientRestriction" ], "summary": "Delete Outbound Recipient Restriction Blocklist", "operationId": "delete_outbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_outbound_blocklist_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "requestBody": { "required": true, "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListBodyRecipientRestriction" } } } }, "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } }, "/seg/config/v1/beta/{customerId}/recipient-restriction/outbound/blocklist/enabled": { "get": { "tags": [ "outboundRecipientRestriction" ], "summary": "Get Outbound Recipient Restriction Blocklist Status", "operationId": "get_outbound_recipient_restriction_blocklist_status_api_v1_seg_config_gateway__customerId__recipient_restriction_outbound_blocklist_enabled_get", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponseStatus" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "put": { "tags": [ "outboundRecipientRestriction" ], "summary": "Enable Outbound Recipient Restriction Blocklist", "operationId": "enable_outbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_outbound_blocklist_enabled_put", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } }, "delete": { "tags": [ "outboundRecipientRestriction" ], "summary": "Disable Outbound Recipient Restriction Blocklist", "operationId": "disable_outbound_recipient_restriction_blocklist_api_v1_seg_config_gateway__customerId__recipient_restriction_outbound_blocklist_enabled_delete", "parameters": [ { "name": "customerId", "in": "path", "required": true, "schema": { "type": "string", "title": "Customerid" } } ], "responses": { "200": { "description": "Successful Response", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ListResponsePutDelete" } } } }, "500": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ErrorResponse" } } }, "description": "Internal Server Error" } } } } }, "components": { "schemas": { "DirectionData": { "properties": { "inbound": { "type": "string", "title": "Inbound" }, "outbound": { "type": "string", "title": "Outbound" } }, "type": "object", "title": "DirectionData" }, "EntryType": { "anyOf": [ { "$ref": "#/components/schemas/EntryTypePhishing" }, { "$ref": "#/components/schemas/EntryTypeCxo" }, { "$ref": "#/components/schemas/EntryTypeAntispam" }, { "$ref": "#/components/schemas/EntryTypeUrlRewrite" }, { "$ref": "#/components/schemas/EntryTypeSenderRestriction" }, { "$ref": "#/components/schemas/EntryTypeRecipientRestriction" } ] }, "EntryTypeAntispam": { "type": "string", "enum": [ "address", "ip" ], "title": "EntryTypeAntispam" }, "EntryTypeCxo": { "type": "string", "enum": [ "domain", "address" ], "title": "EntryTypeCxo" }, "EntryTypePhishing": { "type": "string", "enum": [ "url" ], "title": "EntryTypePhishing" }, "EntryTypeRecipientRestriction": { "type": "string", "enum": [ "domain", "address" ], "title": "EntryTypeRecipientRestriction" }, "EntryTypeSenderRestriction": { "type": "string", "enum": [ "domain", "address", "ip" ], "title": "EntryTypeSenderRestriction" }, "EntryTypeUrlRewrite": { "type": "string", "enum": [ "url" ], "title": "EntryTypeUrlRewrite" }, "ErrorResponse": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "code": { "type": "integer", "title": "Code", "description": "Error code", "examples": [ 500 ] }, "message": { "type": "string", "title": "Message", "description": "Error message", "examples": [ "Internal Server Error" ] } }, "type": "object", "required": [ "code", "message" ], "title": "ErrorResponse" }, "HTTPValidationError": { "properties": { "detail": { "items": { "$ref": "#/components/schemas/ValidationError" }, "type": "array", "title": "Detail" } }, "type": "object", "title": "HTTPValidationError" }, "HealthResponse": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "status": { "type": "string", "enum": [ "OK", "FAIL" ], "title": "Status" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" }, "services": { "items": { "$ref": "#/components/schemas/ServiceHealth" }, "type": "array", "title": "Services" } }, "type": "object", "required": [ "status" ], "title": "HealthResponse" }, "ListBodyAntispam": { "properties": { "entries": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/EntryTypeAntispam" }, "type": "object", "title": "Entries" } }, "type": "object", "required": [ "entries" ], "title": "ListBodyAntispam", "examples": [ { "entries": { "address": [ "user@example.test" ], "ip": [ "203.0.113.10" ] } } ] }, "ListBodyCxo": { "properties": { "entries": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/EntryTypeCxo" }, "type": "object", "title": "Entries" } }, "type": "object", "required": [ "entries" ], "title": "ListBodyCxo", "examples": [ { "entries": { "address": [ "user@example.test" ], "domain": [ "example.com" ] } } ] }, "ListBodyPhishing": { "properties": { "entries": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/EntryTypePhishing" }, "type": "object", "title": "Entries" } }, "type": "object", "required": [ "entries" ], "title": "ListBodyPhishing", "examples": [ { "entries": { "url": [ "https://example.com" ] } } ] }, "ListBodyRecipientRestriction": { "properties": { "entries": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/EntryTypeRecipientRestriction" }, "type": "object", "title": "Entries" } }, "type": "object", "required": [ "entries" ], "title": "ListBodyRecipientRestriction", "examples": [ { "entries": { "address": [ "user@example.test" ], "domain": [ "example.test" ] } } ] }, "ListBodySenderRestriction": { "properties": { "entries": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/EntryTypeSenderRestriction" }, "type": "object", "title": "Entries" } }, "type": "object", "required": [ "entries" ], "title": "ListBodySenderRestriction", "examples": [ { "entries": { "address": [ "user@example.test" ], "domain": [ "example.test" ], "ip": [ "203.0.113.10" ] } } ] }, "ListBodyUrlRewrite": { "properties": { "entries": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/EntryTypeUrlRewrite" }, "type": "object", "title": "Entries" } }, "type": "object", "required": [ "entries" ], "title": "ListBodyUrlRewrite", "examples": [ { "entries": { "url": [ "https://example.com" ] } } ] }, "ListResponseGet": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "lastModifiedTs": { "type": "string", "title": "Lastmodifiedts" }, "lastModifiedBy": { "type": "string", "title": "Lastmodifiedby" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" }, "entries": { "additionalProperties": { "items": { "type": "string" }, "type": "array" }, "propertyNames": { "$ref": "#/components/schemas/EntryType" }, "type": "object", "title": "Entries" } }, "type": "object", "required": [ "lastModifiedTs", "lastModifiedBy", "entries" ], "title": "ListResponseGet" }, "ListResponsePutDelete": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "message": { "type": "string", "title": "Message" } }, "type": "object", "required": [ "message" ], "title": "ListResponsePutDelete" }, "ListResponseStatus": { "properties": { "lastModifiedTs": { "type": "string", "title": "Lastmodifiedts", "description": "Last modified timestamp", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "lastModifiedBy": { "type": "string", "title": "Lastmodifiedby", "description": "Last modified by", "examples": [ "user@example.test" ] }, "enabled": { "type": "boolean", "title": "Enabled", "description": "List enabled status", "examples": [ true ] } }, "type": "object", "required": [ "lastModifiedTs", "lastModifiedBy", "enabled" ], "title": "ListResponseStatus" }, "ListType": { "type": "string", "enum": [ "allowlist", "blocklist" ], "title": "ListType" }, "Order": { "type": "string", "enum": [ "ascending", "descending" ], "title": "Order" }, "PingResponse": { "properties": { "status": { "type": "string", "const": "OK", "title": "Status", "default": "OK" } }, "type": "object", "title": "PingResponse" }, "ServiceHealth": { "properties": { "name": { "type": "string", "title": "Name" }, "status": { "type": "string", "enum": [ "OK", "FAIL" ], "title": "Status" }, "message": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Message" } }, "type": "object", "required": [ "name", "status" ], "title": "ServiceHealth" }, "TransportMetadata": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "customer": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Customer" }, "domain": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Domain" }, "user": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "User" }, "relayId": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Relayid" }, "filter": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Filter" }, "order": { "anyOf": [ { "$ref": "#/components/schemas/Order" }, { "type": "null" } ] }, "nextCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Nextcursor" }, "prevCursor": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Prevcursor" }, "limit": { "anyOf": [ { "type": "integer" }, { "type": "null" } ], "title": "Limit" }, "detailed": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ], "title": "Detailed" }, "lastModifiedBy": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastmodifiedby" }, "lastModifiedAt": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Lastmodifiedat" }, "comment": { "anyOf": [ { "type": "string" }, { "type": "null" } ], "title": "Comment" } }, "type": "object", "title": "TransportMetadata" }, "TransportPayloadAliasesPut": { "properties": { "comment": { "type": "string", "title": "Comment" }, "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases" } }, "type": "object", "required": [ "aliases" ], "title": "TransportPayloadAliasesPut" }, "TransportPayloadDomainsDelete": { "properties": { "domains": { "items": { "type": "string" }, "type": "array", "title": "Domains" } }, "type": "object", "required": [ "domains" ], "title": "TransportPayloadDomainsDelete" }, "TransportPayloadDomainsPutPatch": { "properties": { "comment": { "type": "string", "title": "Comment" }, "domains": { "items": { "$ref": "#/components/schemas/TransportTypeDomainWithDetails" }, "type": "array", "title": "Domains" } }, "type": "object", "required": [ "domains" ], "title": "TransportPayloadDomainsPutPatch" }, "TransportPayloadRelayPut": { "properties": { "comment": { "type": "string", "title": "Comment" }, "relay_id": { "type": "string", "title": "Relay Id" } }, "type": "object", "required": [ "relay_id" ], "title": "TransportPayloadRelayPut" }, "TransportPayloadRelaysDelete": { "properties": { "relay_ids": { "items": { "type": "string" }, "type": "array", "title": "Relay Ids" } }, "type": "object", "required": [ "relay_ids" ], "title": "TransportPayloadRelaysDelete" }, "TransportPayloadRelaysPatch": { "properties": { "comment": { "type": "string", "title": "Comment" }, "relays": { "items": { "$ref": "#/components/schemas/TransportTypeGetPatchRelayWithDetails-Input" }, "type": "array", "title": "Relays" } }, "type": "object", "required": [ "relays" ], "title": "TransportPayloadRelaysPatch" }, "TransportPayloadRelaysPut": { "properties": { "comment": { "type": "string", "title": "Comment" }, "relays": { "items": { "$ref": "#/components/schemas/TransportTypePutRelayWithDetails" }, "type": "array", "title": "Relays" } }, "type": "object", "required": [ "relays" ], "title": "TransportPayloadRelaysPut" }, "TransportPayloadRewritePut": { "properties": { "comment": { "type": "string", "title": "Comment" }, "target": { "type": "string", "title": "Target" } }, "type": "object", "required": [ "target" ], "title": "TransportPayloadRewritePut" }, "TransportPayloadSingleDomainPutPatch": { "properties": { "rewrite": { "$ref": "#/components/schemas/DirectionData" }, "comment": { "type": "string", "title": "Comment" } }, "type": "object", "title": "TransportPayloadSingleDomainPutPatch" }, "TransportPayloadSingleRelayPutPatch": { "properties": { "target": { "type": "string", "title": "Target" }, "type": { "type": "string", "title": "Type" }, "comment": { "type": "string", "title": "Comment" } }, "type": "object", "required": [ "target", "type" ], "title": "TransportPayloadSingleRelayPutPatch" }, "TransportPayloadSingleUserPutPatch": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases" }, "rewrite": { "$ref": "#/components/schemas/DirectionData" }, "relay": { "$ref": "#/components/schemas/DirectionData" }, "comment": { "type": "string", "title": "Comment" } }, "type": "object", "title": "TransportPayloadSingleUserPutPatch" }, "TransportPayloadUsersDelete": { "properties": { "addresses": { "items": { "type": "string" }, "type": "array", "title": "Addresses" } }, "type": "object", "required": [ "addresses" ], "title": "TransportPayloadUsersDelete" }, "TransportPayloadUsersPutPatch": { "properties": { "comment": { "type": "string", "title": "Comment" }, "users": { "items": { "$ref": "#/components/schemas/TransportTypeUserWithDetails" }, "type": "array", "title": "Users" } }, "type": "object", "required": [ "users" ], "title": "TransportPayloadUsersPutPatch" }, "TransportResponseGet_TransportTypeDomainDetails_": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "$ref": "#/components/schemas/TransportTypeDomainDetails" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[TransportTypeDomainDetails]" }, "TransportResponseGet_TransportTypeRelayDetails_": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "$ref": "#/components/schemas/TransportTypeRelayDetails" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[TransportTypeRelayDetails]" }, "TransportResponseGet_TransportTypeUserDetails_": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "$ref": "#/components/schemas/TransportTypeUserDetails" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[TransportTypeUserDetails]" }, "TransportResponseGet_list_TransportTypeDomainWithDetails__": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "items": { "$ref": "#/components/schemas/TransportTypeDomainWithDetails" }, "type": "array", "title": "Result" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[list[TransportTypeDomainWithDetails]]" }, "TransportResponseGet_list_TransportTypeGetPatchRelayWithDetails__": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "items": { "$ref": "#/components/schemas/TransportTypeGetPatchRelayWithDetails-Output" }, "type": "array", "title": "Result" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[list[TransportTypeGetPatchRelayWithDetails]]" }, "TransportResponseGet_list_TransportTypeUserWithDetails__": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "items": { "$ref": "#/components/schemas/TransportTypeUserWithDetails" }, "type": "array", "title": "Result" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[list[TransportTypeUserWithDetails]]" }, "TransportResponseGet_list_str__": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "items": { "type": "string" }, "type": "array", "title": "Result" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[list[str]]" }, "TransportResponseGet_str_": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "metadata": { "$ref": "#/components/schemas/TransportMetadata" }, "result": { "type": "string", "title": "Result" } }, "type": "object", "required": [ "metadata", "result" ], "title": "TransportResponseGet[str]" }, "TransportResponsePutPatchDelete": { "properties": { "timestamp": { "type": "string", "title": "Timestamp", "description": "Response timestamp, format: %Y-%m-%dT%H:%M:%S.%f%z", "examples": [ "2026-01-01T00:00:00.000Z" ] }, "message": { "type": "string", "title": "Message" }, "unsuccessful": { "anyOf": [ { "items": { "type": "string" }, "type": "array" }, { "type": "null" } ], "title": "Unsuccessful" } }, "type": "object", "required": [ "message" ], "title": "TransportResponsePutPatchDelete" }, "TransportTypeDomainDetails": { "properties": { "rewrite": { "$ref": "#/components/schemas/DirectionData" } }, "type": "object", "title": "TransportTypeDomainDetails" }, "TransportTypeDomainWithDetails": { "properties": { "domain": { "type": "string", "title": "Domain" }, "rewrite": { "$ref": "#/components/schemas/DirectionData" } }, "type": "object", "required": [ "domain" ], "title": "TransportTypeDomainWithDetails" }, "TransportTypeGetPatchRelayWithDetails-Input": { "properties": { "relay_id": { "type": "string", "title": "Relay Id" }, "target": { "type": "string", "title": "Target" }, "type": { "type": "string", "title": "Type" } }, "type": "object", "required": [ "relay_id" ], "title": "TransportTypeGetPatchRelayWithDetails" }, "TransportTypeGetPatchRelayWithDetails-Output": { "properties": { "relayId": { "type": "string", "title": "Relayid" }, "target": { "type": "string", "title": "Target" }, "type": { "type": "string", "title": "Type" } }, "type": "object", "required": [ "relayId" ], "title": "TransportTypeGetPatchRelayWithDetails" }, "TransportTypePutRelayWithDetails": { "properties": { "relay_id": { "type": "string", "title": "Relay Id" }, "target": { "type": "string", "title": "Target" }, "type": { "type": "string", "title": "Type" } }, "type": "object", "required": [ "relay_id", "target", "type" ], "title": "TransportTypePutRelayWithDetails" }, "TransportTypeRelayDetails": { "properties": { "target": { "type": "string", "title": "Target" }, "type": { "type": "string", "title": "Type" } }, "type": "object", "required": [ "target", "type" ], "title": "TransportTypeRelayDetails" }, "TransportTypeUserDetails": { "properties": { "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases" }, "rewrite": { "$ref": "#/components/schemas/DirectionData" }, "relay": { "$ref": "#/components/schemas/DirectionData" } }, "type": "object", "title": "TransportTypeUserDetails" }, "TransportTypeUserWithDetails": { "properties": { "address": { "type": "string", "title": "Address" }, "aliases": { "items": { "type": "string" }, "type": "array", "title": "Aliases" }, "rewrite": { "$ref": "#/components/schemas/DirectionData" }, "relay": { "$ref": "#/components/schemas/DirectionData" } }, "type": "object", "required": [ "address" ], "title": "TransportTypeUserWithDetails" }, "ValidationError": { "properties": { "loc": { "items": { "anyOf": [ { "type": "string" }, { "type": "integer" } ] }, "type": "array", "title": "Location" }, "msg": { "type": "string", "title": "Message" }, "type": { "type": "string", "title": "Error Type" }, "input": { "title": "Input" }, "ctx": { "type": "object", "title": "Context" } }, "type": "object", "required": [ "loc", "msg", "type" ], "title": "ValidationError" } }, "securitySchemes": { "Prod": { "type": "oauth2", "flows": { "clientCredentials": { "scopes": {}, "tokenUrl": "https://api-auth-service.eu.retarus.com/realms/platform/protocol/openid-connect/token" } } } } }, "servers": [ { "url": "https://api.retarus.com" } ], "security": [ { "Prod": [] } ], "tags": [ { "name": "token", "summary": "Token", "description": "The Configuration API uses the OAuth 2.0 Client Credentials grant.\n\nRequest API credentials from Retarus before calling the API. Keep the client secret and every access token confidential; do not commit them to source control or write them to application logs.\n\n## Generate an access token\n\nSend a `POST` request to `https://api-auth-service.eu.retarus.com/realms/platform/protocol/openid-connect/token` with the content type `application/x-www-form-urlencoded` and these form fields:\n\n| Field | Value |\n| --- | --- |\n| `grant_type` | `client_credentials` |\n| `client_id` | Client ID supplied by Retarus |\n| `client_secret` | Client secret supplied by Retarus |\n\nA successful response contains `access_token`, `expires_in`, `token_type`, and the granted `scope`. Use the `access_token` as an HTTP Bearer token for Configuration API requests:\n\n`Authorization: Bearer `\n\nAccess tokens are short-lived. Cache a token only until shortly before `expires_in` elapses, then request a new one with the same client credentials. A Client Credentials token is not renewed with an end-user refresh-token flow.\n\n## Example request\n\n```bash\ncurl --request POST \\\n --url \"https://api-auth-service.eu.retarus.com/realms/platform/protocol/openid-connect/token\" \\\n --header \"Content-Type: application/x-www-form-urlencoded\" \\\n --data-urlencode \"grant_type=client_credentials\" \\\n --data-urlencode \"client_id=\" \\\n --data-urlencode \"client_secret=\"\n```\n\n## Example response\n\n```json\n{\n \"access_token\": \"\",\n \"expires_in\": 300,\n \"token_type\": \"Bearer\",\n \"scope\": \"\"\n}\n```\n\n## Use the token\n\n```bash\ncurl --header \"Authorization: Bearer \" \\\n \"https://api.retarus.com/seg/config/v1/beta//directory/domains\"\n```\n", "kind": "nav" }, { "name": "directoryAdministration", "summary": "Directory Administration", "description": "Manage domains, users, relays, aliases, and routing assignments.", "kind": "nav" }, { "name": "domains", "summary": "Domains", "description": "Create, read, update, and delete managed domains.", "kind": "nav", "parent": "directoryAdministration" }, { "name": "users", "summary": "Users", "description": "Manage users globally or within a managed domain.", "kind": "nav", "parent": "directoryAdministration" }, { "name": "relaySetup", "summary": "Relay Setup", "description": "Create and maintain relay definitions.", "kind": "nav", "parent": "directoryAdministration" }, { "name": "aliasManagement", "summary": "Alias Management", "description": "Manage aliases assigned to directory users.", "kind": "nav", "parent": "directoryAdministration" }, { "name": "rewriteManagement", "summary": "Rewrite Management", "description": "Manage inbound and outbound address rewriting for domains and users.", "kind": "nav", "parent": "directoryAdministration" }, { "name": "relayManagement", "summary": "Relay Management", "description": "Assign inbound and outbound relays to directory users.", "kind": "nav", "parent": "directoryAdministration" }, { "name": "listManagement", "summary": "List Management", "description": "Manage inbound and outbound allowlists and blocklists.", "kind": "nav" }, { "name": "inbound", "summary": "Inbound", "description": "Manage lists applied to inbound email traffic.", "kind": "nav", "parent": "listManagement" }, { "name": "inboundSenderRestriction", "summary": "Sender Restriction", "description": "Manage the inbound sender restriction blocklist.", "kind": "nav", "parent": "inbound" }, { "name": "inboundRecipientRestriction", "summary": "Recipient Restriction", "description": "Manage the inbound recipient restriction blocklist.", "kind": "nav", "parent": "inbound" }, { "name": "antispam", "summary": "AntiSpam", "description": "Manage AntiSpam allowlists and blocklists by configuration level.", "kind": "nav", "parent": "inbound" }, { "name": "antispamCustomer", "summary": "Customer Level", "description": "Manage customer-level AntiSpam list entries.", "kind": "nav", "parent": "antispam" }, { "name": "antispamProfile", "summary": "Profile Level", "description": "Manage profile-level AntiSpam list entries.", "kind": "nav", "parent": "antispam" }, { "name": "antispamUser", "summary": "User Level", "description": "Manage user-level AntiSpam list entries.", "kind": "nav", "parent": "antispam" }, { "name": "phishingUrls", "summary": "Phishing URLs", "description": "Manage phishing URL detection lists.", "kind": "nav", "parent": "inbound" }, { "name": "cxoFraud", "summary": "CxO Fraud", "description": "Manage CxO fraud protection lists.", "kind": "nav", "parent": "inbound" }, { "name": "urlRewriteTimeOfClick", "summary": "URL Rewrite / Time-of-Click", "description": "Manage URL Rewrite and Time-of-Click exception lists.", "kind": "nav", "parent": "inbound" }, { "name": "outbound", "summary": "Outbound", "description": "Manage lists applied to outbound email traffic.", "kind": "nav", "parent": "listManagement" }, { "name": "outboundSenderRestriction", "summary": "Sender Restriction", "description": "Manage outbound sender restriction lists.", "kind": "nav", "parent": "outbound" }, { "name": "outboundSenderRestrictionBlocklist", "summary": "Blocklist", "description": "Manage the outbound sender restriction blocklist.", "kind": "nav", "parent": "outboundSenderRestriction" }, { "name": "outboundSenderRestrictionAllowlist", "summary": "Allowlist", "description": "Manage the outbound sender restriction allowlist.", "kind": "nav", "parent": "outboundSenderRestriction" }, { "name": "outboundRecipientRestriction", "summary": "Recipient Restriction", "description": "Manage the outbound recipient restriction blocklist.", "kind": "nav", "parent": "outbound" } ] }