{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula External Authentication Command", "description": "**External Authentication Command API**:\n\n
External Authentication API provides methods to configure mTLS authentication for specific URLs.\n\n
**External Authentication API provides**:
", "version": "1.0" }, "servers": [ { "url": "/externalauthenticationcommand" } ], "paths": { "/api/configuration": { "post": { "tags": [ "EndpointConfiguration" ], "description": "

Required permissions:
Following permissions are required: ExternalAuthenticationCreate", "operationId": "CreateConfiguration", "parameters": [ { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEndpointConfigurationDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointConfigurationCreatedDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "security": [ { "Bearer": [ ] } ] }, "put": { "tags": [ "EndpointConfiguration" ], "description": "

Required permissions:
Following permissions are required: ExternalAuthenticationEdit", "operationId": "UpdateConfiguration", "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "requestBody": { "content": { "application/json": { "schema": { "allOf": [ { "$ref": "#/components/schemas/CreateEndpointConfigurationDtoServiceRequest" } ] } } } }, "responses": { "202": { "description": "Accepted", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/EndpointConfigurationUpdatedDtoServiceResponse" } } } }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "security": [ { "Bearer": [ ] } ] }, "delete": { "tags": [ "EndpointConfiguration" ], "description": "

Required permissions:
Following permissions are required: ExternalAuthenticationDelete", "operationId": "DeleteConfiguration", "parameters": [ { "name": "configurationId", "in": "query", "required": true, "schema": { "type": "string", "format": "uuid" } }, { "name": "X-TENANT-ID", "in": "header", "description": "The UiD of the tenant representing organization", "required": true, "schema": { "type": "string" }, "example": "b11f8be3-f29b-4959-8964-956d4af7c468" } ], "responses": { "202": { "description": "Accepted" }, "400": { "description": "Bad Request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "500": { "description": "Internal Server Error" }, "401": { "description": "User is not authorized to perform this request", "content": { "application/json": { "example": { "message": "Unauthorized" } } } }, "403": { "description": "Access to resource is forbidden.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Access denied. Following permissions are required: Permission1, Permission2", "type": "Forbidden", "errorCode": "Error Code" } ] } } } }, "410": { "description": "Endpoint marked as deprecated was terminated. This response will be present only if the endpoint was marked as deprecated and has reached the sunset date. During the deprecation period, the API will include additional 'sunset' and 'deprecation' headers.", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/StringServiceResponse" }, "example": { "data": null, "messages": [ { "message": "This endpoint is obsolete and was terminated on yyyy-MM-dd", "type": "Error", "errorCode": "OBSOLETE_ENDPOINT" } ] } } } } }, "security": [ { "Bearer": [ ] } ] } } }, "components": { "schemas": { "ClientCredentialsConfigurationDto": { "required": [ "clientId", "url", "useBasicAuthentication", "useEndpointMtlsConfiguration" ], "type": "object", "properties": { "clientId": { "minLength": 1, "type": "string", "description": "Client Id", "example": "my-client-id" }, "clientSecret": { "type": "string", "description": "Client secret", "nullable": true, "example": "my-client-secret" }, "useBasicAuthentication": { "type": "boolean", "description": "Flag to determine if to use basic authentication type" }, "url": { "minLength": 1, "type": "string", "description": "Contains the URL that relates to this configuration", "example": "https://www.mydomain.com/oauth2/token" }, "isMtlsEnabled": { "type": "boolean", "description": "Indicates if the URL specified above is mTLS enabled", "example": true }, "isJwtClientAssertionEnabled": { "type": "boolean", "description": "Indicates if the URL specified above should use jwt client assertion authentication", "nullable": true, "example": true }, "isJwtClientAssertionEnabledValue": { "type": "boolean", "description": "Indicates the same as Fenergo.Nebula.ExternalAuthentication.Command.Application.Dto.OAuth.ClientCredentialsConfigurationDto.IsJwtClientAssertionEnabled but it's normalized to false when null", "readOnly": true, "example": true }, "endpointCertificate": { "allOf": [ { "$ref": "#/components/schemas/EndpointCertificateDto" } ], "description": "Contains the certificate settings for the URL specified above. Required when IsMtlsEnabled set to true and UseEndpointMtlsConfiguration is set to false.\n(optional)", "nullable": true }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/HeaderPropertyDto" }, "description": "Contains an array of any optional headers that must be sent as part of each request\n(optional)", "nullable": true }, "useEndpointMtlsConfiguration": { "type": "boolean", "description": "Flag to determine if OAuth configuration should use base mtls configuration" }, "formValues": { "type": "array", "items": { "$ref": "#/components/schemas/FormPropertyDto" }, "description": "Form values parameters: Contains an array of any optional form values that can be sent as part of each request\n(optional)", "nullable": true } }, "additionalProperties": false }, "CreateEndpointConfigurationDto": { "type": "object", "properties": { "url": { "type": "string", "description": "Contains the URL that relates to this configuration", "nullable": true, "example": "https://www.mydomain.com/api" }, "isMtlsEnabled": { "type": "boolean", "description": "Indicates if the URL specified above is mTLS enabled", "example": true }, "endpointCertificate": { "allOf": [ { "$ref": "#/components/schemas/EndpointCertificateDto" } ], "description": "Contains the certificate settings for the URL specified above. Required when IsMtlsEnabled set to true\n(optional)", "nullable": true }, "headers": { "type": "array", "items": { "$ref": "#/components/schemas/HeaderPropertyDto" }, "description": "Contains an array of any optional headers that must be sent as part of each request\n(optional)", "nullable": true }, "oAuthConfiguration": { "allOf": [ { "$ref": "#/components/schemas/OAuthConfigurationDto" } ], "nullable": true } }, "additionalProperties": false, "description": "Request DTO to create or update endpoint configuration" }, "CreateEndpointConfigurationDtoServiceRequest": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/CreateEndpointConfigurationDto" } ], "description": "Request DTO to create or update endpoint configuration", "nullable": true } }, "additionalProperties": false }, "EndpointCertificateDto": { "required": [ "certificate", "isPublicCA" ], "type": "object", "properties": { "isPublicCA": { "type": "boolean", "description": "Specifies that the certificate presented is a publicly signed certificate (or not)", "example": true }, "certificate": { "minLength": 1, "type": "string", "description": "Contains the PEM-encoded public key certificate for the specified url. Is required if 'isPublicCA' is set to false\n(optional)", "example": "-----BEGIN CERTIFICATE-----\\nMIICUTCCAfugAwIBAgIBADANBgkqhkiG9w0BAQQFADBXMQswCQYDVQQGEwJ...\\n-----END CERTIFICATE-----\\n" } }, "additionalProperties": false, "description": "DTO to specify server certificate properties" }, "EndpointConfigurationCreatedDto": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "The unique ID for the endpoint configuration.", "format": "uuid", "example": "12be522e-66c2-44bb-851e-afc4fc4a33c2" } }, "additionalProperties": false, "description": "Represents the data of a configuration that has been created" }, "EndpointConfigurationCreatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EndpointConfigurationCreatedDto" } ], "description": "Represents the data of a configuration that has been created", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "EndpointConfigurationUpdatedDto": { "type": "object", "properties": { "configurationId": { "type": "string", "description": "The unique ID for the endpoint configuration.", "format": "uuid", "example": "12be522e-66c2-44bb-851e-afc4fc4a33c2" } }, "additionalProperties": false, "description": "Represents the data of a configuration that has been updated" }, "EndpointConfigurationUpdatedDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/EndpointConfigurationUpdatedDto" } ], "description": "Represents the data of a configuration that has been updated", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "FormPropertyDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of Property", "nullable": true, "example": "property-name" }, "value": { "type": "string", "description": "Name of Value", "nullable": true, "example": "property-value" } }, "additionalProperties": false }, "HeaderPropertyDto": { "type": "object", "properties": { "name": { "type": "string", "description": "Name of Property", "nullable": true, "example": "property-name" }, "value": { "type": "string", "description": "Name of Value", "nullable": true, "example": "property-value" } }, "additionalProperties": false, "description": "DTO to specify optional request headers" }, "OAuthConfigurationDto": { "type": "object", "properties": { "clientCredentialsConfig": { "allOf": [ { "$ref": "#/components/schemas/ClientCredentialsConfigurationDto" } ], "nullable": true } }, "additionalProperties": false }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ServiceResponseMessage": { "type": "object", "properties": { "message": { "type": "string", "nullable": true }, "type": { "type": "string", "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "StringServiceResponse": { "type": "object", "properties": { "data": { "type": "string", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ValidationErrorModel": { "type": "object", "properties": { "propertyName": { "type": "string", "nullable": true }, "errorMessage": { "type": "string", "nullable": true }, "attemptedValue": { "nullable": true }, "errorCode": { "type": "string", "nullable": true } }, "additionalProperties": false }, "ValidationErrorModelListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/ValidationErrorModel" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false, "example": { "data": [ { "propertyName": "data", "errorMessage": "Data is required", "attemptedValue": "", "errorCode": "NotNullValidator" } ], "messages": [ { "message": "Data is required", "type": "Error", "errorCode": "Error Code" } ] } } }, "securitySchemes": { "Bearer": { "type": "apiKey", "description": "Please insert JWT with Bearer into field", "name": "Authorization", "in": "header" } } } }