{ "openapi": "3.0.4", "info": { "title": "Fenergo Nebula External Authentication Query", "description": "**External Authentication Query API**:\n\n
External Authentication Query API provides methods to retrieve mTLS authentication settings.\n\n
**External Authentication Query API provides**:
", "version": "1.0" }, "servers": [ { "url": "/externalauthenticationquery" } ], "paths": { "/api/configuration/{configurationId}": { "get": { "tags": [ "EndpointConfiguration" ], "summary": "Get endpoint configuration for a single configuration ID.", "description": "\nThis method accepts a configuration ID.\n\nThe method then returns all endpoint configuration for a specific configuration ID.

Required permissions:
Following permissions are required: ExternalAuthenticationAccess", "operationId": "GetConfigurationById", "parameters": [ { "name": "configurationId", "in": "path", "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": { "200": { "description": "Success. Endpoint configurations are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetByIdEndpointConfigurationResponseDtoServiceResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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": [ ] } ] } }, "/api/configuration/getAll": { "get": { "tags": [ "EndpointConfiguration" ], "summary": "Get all your endpoint configurations.", "description": "

Required permissions:
Following permissions are required: ExternalAuthenticationAccess", "operationId": "GetAllConfigurationsByTenant", "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" } ], "responses": { "200": { "description": "Success. Endpoint configurations are returned", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/GetAllEndpointConfigurationResponseDtoListServiceResponse" } } } }, "400": { "description": "Bad request", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ValidationErrorModelListServiceResponse" } } } }, "404": { "description": "Resource not found", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/ObjectServiceResponse" }, "example": { "data": { }, "messages": [ { "message": "Not Found", "type": "Error", "errorCode": "Error Code" } ] } } } }, "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": { "AuthType": { "enum": [ "OAuthClientCredentials" ], "type": "string" }, "EndpointCertificateDto": { "type": "object", "properties": { "isPublicCA": { "type": "boolean", "description": "Specifies that the certificate presented is a publicly signed certificate (or not)", "example": true }, "certificate": { "type": "string", "description": "Contains the PEM-encoded public key certificate for the specified url. Is required if 'isPublicCA' is set to false\n(optional)", "nullable": true, "example": "-----BEGIN CERTIFICATE-----\\nMIICUTCCAfugAwIBAgIBADANBgkqhkiG9w0BAQQFADBXMQswCQYDVQQGEwJ...\\n-----END CERTIFICATE-----\\n" }, "certificateDetails": { "type": "object", "additionalProperties": { "type": "string", "nullable": true }, "description": "Contains all attributes of a certificate", "nullable": true } }, "additionalProperties": false, "description": "Query DTO to return server certificate properties" }, "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, "description": "Query DTO to specify form properties" }, "GetAllClientCredentialsConfigurationResponseDto": { "type": "object", "properties": { "url": { "type": "string", "description": "Contains the URL that relates to this configuration", "nullable": true, "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 }, "hasFormValues": { "type": "boolean", "description": "Indicates if the endpoint contains form values", "example": true }, "hasHeaders": { "type": "boolean", "description": "Indicates if the endpoint contains headers", "example": true }, "containsCertificate": { "type": "boolean", "description": "Indicates if the endpoint is Oauth enabled", "example": true }, "useBasicAuthentication": { "type": "boolean", "description": "Flag to determine if to use basic authentication type", "example": true }, "useMtlsEndpointConfiguration": { "type": "boolean", "description": "Flag to determine if to use Mtls endpoint configuration", "example": true } }, "additionalProperties": false, "description": "Query DTO to return client credentials configurations" }, "GetAllEndpointConfigurationResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Contains the unique ID that relates to this configuration", "nullable": true, "example": "4ce5403d-bc16-47bb-9c69-9797dccb49c6" }, "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 }, "hasHeaders": { "type": "boolean", "description": "Indicates if the endpoint contains headers", "example": true }, "containsCertificate": { "type": "boolean", "description": "Indicates if the endpoint contains a certificate", "example": true }, "isOauthEnabled": { "type": "boolean", "description": "Indicates if the endpoint is Oauth enabled", "example": true }, "oAuthConfiguration": { "allOf": [ { "$ref": "#/components/schemas/GetAllOAuthConfigurationResponseDto" } ], "description": "Contains Oauth configuration settings\n(optional)", "nullable": true } }, "additionalProperties": false, "description": "Query DTO to return list of endpoint configurations" }, "GetAllEndpointConfigurationResponseDtoListServiceResponse": { "type": "object", "properties": { "data": { "type": "array", "items": { "$ref": "#/components/schemas/GetAllEndpointConfigurationResponseDto" }, "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetAllOAuthConfigurationResponseDto": { "type": "object", "properties": { "authType": { "allOf": [ { "$ref": "#/components/schemas/AuthType" } ], "description": "Contains Auth type" }, "clientCredentials": { "allOf": [ { "$ref": "#/components/schemas/GetAllClientCredentialsConfigurationResponseDto" } ], "description": "Contains client credentials configurations", "nullable": true } }, "additionalProperties": false, "description": "Query DTO to return list of Oauth configurations" }, "GetByIdClientCredentialsConfigurationResponseDto": { "type": "object", "properties": { "clientId": { "type": "string", "description": "Client Id", "nullable": true, "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", "example": true }, "tokenEndpoint": { "allOf": [ { "$ref": "#/components/schemas/GetByIdUrlConfigurationResponseDto" } ], "description": "Contains the configuration setting for a token endpoint", "nullable": true }, "useMtlsEndpointConfiguration": { "type": "boolean", "description": "Flag to determine if to use Mtls endpoint configuration", "example": true } }, "additionalProperties": false, "description": "Query DTO to return client credentials configuration" }, "GetByIdEndpointConfigurationResponseDto": { "type": "object", "properties": { "id": { "type": "string", "description": "Contains the unique ID that relates to this configuration", "nullable": true, "example": "4ce5403d-bc16-47bb-9c69-9797dccb49c6" }, "tenantId": { "type": "string", "description": "Contains the Tenant ID that relates to this configuration", "nullable": true, "example": "d5234c56-0594-41d4-a118-5b1f3ceee348" }, "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 }, "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 }, "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 }, "oAuthConfiguration": { "allOf": [ { "$ref": "#/components/schemas/GetByIdOAuthConfigurationResponseDto" } ], "description": "Contains Oauth configuration settings\n(optional)", "nullable": true } }, "additionalProperties": false, "description": "Query DTO to return endpoint configurations" }, "GetByIdEndpointConfigurationResponseDtoServiceResponse": { "type": "object", "properties": { "data": { "allOf": [ { "$ref": "#/components/schemas/GetByIdEndpointConfigurationResponseDto" } ], "description": "Query DTO to return endpoint configurations", "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "GetByIdMtlsCertificateConfigurationResponseDto": { "type": "object", "properties": { "endpointCertificate": { "allOf": [ { "$ref": "#/components/schemas/EndpointCertificateDto" } ], "description": "Contains the certificate settings", "nullable": true } }, "additionalProperties": false }, "GetByIdOAuthConfigurationResponseDto": { "type": "object", "properties": { "authType": { "allOf": [ { "$ref": "#/components/schemas/AuthType" } ], "description": "Contains Auth type" }, "clientCredentialsConfig": { "allOf": [ { "$ref": "#/components/schemas/GetByIdClientCredentialsConfigurationResponseDto" } ], "description": "Contains client credentials configurations", "nullable": true } }, "additionalProperties": false, "description": "Query DTO to return list of Oauth configurations" }, "GetByIdUrlConfigurationResponseDto": { "type": "object", "properties": { "url": { "type": "string", "description": "Contains the URL that relates to this configuration", "nullable": true, "example": "https://www.mydomain.com/oauth2/token" }, "isMtlsEnabled": { "type": "boolean", "description": "Indicates if the URL specified above is mTLS enabled", "example": true }, "mtlsConfiguration": { "allOf": [ { "$ref": "#/components/schemas/GetByIdMtlsCertificateConfigurationResponseDto" } ], "description": "Contains Mtls configuration settings", "nullable": true }, "isJwtClientAssertionEnabled": { "type": "boolean", "description": "Indicates if the URL specified above should use jwt client assertion authentication", "nullable": true, "example": true }, "jwksUrl": { "type": "string", "description": "Indicates the URL path to request for the JWKS endpoint", "nullable": true, "readOnly": true, "example": "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 }, "formProperties": { "type": "array", "items": { "$ref": "#/components/schemas/FormPropertyDto" }, "description": "Contains an array of any optional form values that can be sent as part of each request\n(optional)", "nullable": true } }, "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": "Query DTO to specify headers" }, "ObjectServiceResponse": { "type": "object", "properties": { "data": { "nullable": true }, "messages": { "type": "array", "items": { "$ref": "#/components/schemas/ServiceResponseMessage" }, "nullable": true } }, "additionalProperties": false }, "ProblemDetails": { "type": "object", "properties": { "type": { "type": "string", "nullable": true }, "title": { "type": "string", "nullable": true }, "status": { "type": "integer", "format": "int32", "nullable": true }, "detail": { "type": "string", "nullable": true }, "instance": { "type": "string", "nullable": true } }, "additionalProperties": { } }, "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" } } } }