Modified: syncope/site/3.0.5/rest/3.0/openapi.json URL: http://svn.apache.org/viewvc/syncope/site/3.0.5/rest/3.0/openapi.json?rev=1912612&r1=1912611&r2=1912612&view=diff ============================================================================== --- syncope/site/3.0.5/rest/3.0/openapi.json (original) +++ syncope/site/3.0.5/rest/3.0/openapi.json Fri Sep 29 15:11:24 2023 @@ -12,7 +12,7 @@ "name" : "Apache 2.0 License", "url" : "http://www.apache.org/licenses/LICENSE-2.0.html"; }, - "version" : "3.0.5" + "version" : "3.0.5-SNAPSHOT" }, "servers" : [ { "url" : "/syncope/rest" @@ -55,17 +55,6 @@ "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; } } - }, { - "name" : "X-Syncope-Delegated-By", - "in" : "header", - "required" : false, - "schema" : { - "description" : "Acton behalf of someone else", - "externalDocs" : { - "description" : "Apache Syncope Reference Guide", - "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; - } - } } ], "responses" : { "204" : { @@ -230,19 +219,6 @@ "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; } } - }, { - "name" : "X-Syncope-Domain", - "in" : "header", - "required" : true, - "schema" : { - "description" : "Domains are built to facilitate multitenancy.", - "externalDocs" : { - "description" : "Apache Syncope Reference Guide", - "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; - }, - "default" : "Master", - "enum" : [ "Master", "Two" ] - } } ], "responses" : { "200" : { @@ -867,19 +843,6 @@ "enum" : [ "Master", "Two" ] } }, { - "name" : "X-Syncope-Domain", - "in" : "header", - "required" : true, - "schema" : { - "description" : "Domains are built to facilitate multitenancy.", - "externalDocs" : { - "description" : "Apache Syncope Reference Guide", - "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; - }, - "default" : "Master", - "enum" : [ "Master", "Two" ] - } - }, { "name" : "X-Syncope-Delegated-By", "in" : "header", "required" : false, @@ -2260,7 +2223,7 @@ "get" : { "tags" : [ "AnyObjects" ], "summary" : "Reads the attribute, owned by the given any object, for the given schema type and schema.\n\n Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter\n looks like a UUID then it is interpreted as as key, otherwise as a (user)name.", - "operationId" : "read_2", + "operationId" : "read_3", "parameters" : [ { "name" : "key", "in" : "path", @@ -2620,7 +2583,7 @@ "delete" : { "tags" : [ "AnyObjects" ], "summary" : "Deletes the attribute, owned by the given any object, for the given schema type and schema.", - "operationId" : "deleteAttr_1", + "operationId" : "deleteAttr", "parameters" : [ { "name" : "key", "in" : "path", @@ -2939,7 +2902,7 @@ "get" : { "tags" : [ "AnyObjects" ], "summary" : "Reads the list of attributes owned by the given any object for the given schema type.\n\n Note that for the UserService, GroupService and AnyObjectService subclasses, if the key parameter\n looks like a UUID then it is interpreted as as key, otherwise as a (user)name.", - "operationId" : "read_4", + "operationId" : "read_2", "parameters" : [ { "name" : "key", "in" : "path", @@ -3453,7 +3416,7 @@ "get" : { "tags" : [ "AnyTypeClasses" ], "summary" : "Returns anyTypeClass with matching key.", - "operationId" : "read_3", + "operationId" : "read_4", "parameters" : [ { "name" : "key", "in" : "path", @@ -3914,15 +3877,347 @@ } ] } }, - "/anyTypeClasses/{key}" : { + "/anyTypes" : { "get" : { - "tags" : [ "AnyTypeClasses" ], - "summary" : "Returns anyTypeClass with matching key.", - "operationId" : "read_3", + "tags" : [ "AnyTypes" ], + "summary" : "Returns a list of all anyTypes.", + "operationId" : "list_2", + "parameters" : [ { + "name" : "X-Syncope-Domain", + "in" : "header", + "required" : true, + "schema" : { + "description" : "Domains are built to facilitate multitenancy.", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; + }, + "default" : "Master", + "enum" : [ "Master", "Two" ] + } + }, { + "name" : "X-Syncope-Delegated-By", + "in" : "header", + "required" : false, + "schema" : { + "description" : "Acton behalf of someone else", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; + } + } + } ], + "responses" : { + "200" : { + "description" : "list of all anyTypes.", + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AnyTypeTO" + } + } + }, + "application/yaml" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AnyTypeTO" + } + } + }, + "application/xml" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AnyTypeTO" + } + } + } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + } + } + } + }, + "security" : [ { + "BasicAuthentication" : [ ] + }, { + "Bearer" : [ ] + } ] + }, + "post" : { + "tags" : [ "AnyTypes" ], + "summary" : "Creates a new anyType.", + "operationId" : "create_2", + "parameters" : [ { + "name" : "X-Syncope-Domain", + "in" : "header", + "required" : true, + "schema" : { + "description" : "Domains are built to facilitate multitenancy.", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; + }, + "default" : "Master", + "enum" : [ "Master", "Two" ] + } + }, { + "name" : "X-Syncope-Delegated-By", + "in" : "header", + "required" : false, + "schema" : { + "description" : "Acton behalf of someone else", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; + } + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AnyTypeTO" + } + }, + "application/yaml" : { + "schema" : { + "$ref" : "#/components/schemas/AnyTypeTO" + } + }, + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/AnyTypeTO" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "AnyType successfully created", + "headers" : { + "X-Syncope-Key" : { + "description" : "Key value for the entity created", + "style" : "simple", + "schema" : { + "type" : "string" + } + }, + "Location" : { + "description" : "URL of the entity created", + "style" : "simple", + "schema" : { + "type" : "string" + } + } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + } + } + } + }, + "security" : [ { + "BasicAuthentication" : [ ] + }, { + "Bearer" : [ ] + } ] + } + }, + "/anyTypes/{key}" : { + "get" : { + "tags" : [ "AnyTypes" ], + "summary" : "Returns anyType with matching key.", + "operationId" : "read_5", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "anyTypeClass key to be read", + "description" : "anyType key to be read", "required" : true, "schema" : { "type" : "string" @@ -3954,21 +4249,21 @@ } ], "responses" : { "200" : { - "description" : "anyTypeClass with matching key", + "description" : "anyType with matching key", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeClassTO" + "$ref" : "#/components/schemas/AnyTypeTO" } }, "application/yaml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeClassTO" + "$ref" : "#/components/schemas/AnyTypeTO" } }, "application/xml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeClassTO" + "$ref" : "#/components/schemas/AnyTypeTO" } } } @@ -4075,13 +4370,13 @@ } ] }, "put" : { - "tags" : [ "AnyTypeClasses" ], - "summary" : "Updates the anyTypeClass matching the provided key.", - "operationId" : "update_2", + "tags" : [ "AnyTypes" ], + "summary" : "Updates the anyType matching the provided key.", + "operationId" : "update_3", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "AnyTypeClass's key", + "description" : "AnyType's key", "required" : true, "schema" : { "type" : "string" @@ -4115,17 +4410,17 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeClassTO" + "$ref" : "#/components/schemas/AnyTypeTO" } }, "application/yaml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeClassTO" + "$ref" : "#/components/schemas/AnyTypeTO" } }, "application/xml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeClassTO" + "$ref" : "#/components/schemas/AnyTypeTO" } } }, @@ -4237,13 +4532,13 @@ } ] }, "delete" : { - "tags" : [ "AnyTypeClasses" ], - "summary" : "Deletes the anyTypeClass matching the provided key.", - "operationId" : "delete_1", + "tags" : [ "AnyTypes" ], + "summary" : "Deletes the anyType matching the provided key.", + "operationId" : "delete_2", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "anyTypeClass key to be deleted", + "description" : "anyType key to be deleted", "required" : true, "schema" : { "type" : "string" @@ -4379,11 +4674,11 @@ } ] } }, - "/anyTypes" : { + "/applications" : { "get" : { - "tags" : [ "AnyTypes" ], - "summary" : "Returns a list of all anyTypes.", - "operationId" : "list_2", + "tags" : [ "Applications" ], + "summary" : "Returns a list of all applications.", + "operationId" : "list_3", "parameters" : [ { "name" : "X-Syncope-Domain", "in" : "header", @@ -4411,13 +4706,13 @@ } ], "responses" : { "200" : { - "description" : "list of all anyTypes.", + "description" : "list of all applications.", "content" : { "application/json" : { "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } } }, @@ -4425,7 +4720,7 @@ "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } } }, @@ -4433,7 +4728,7 @@ "schema" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } } } @@ -4541,9 +4836,9 @@ } ] }, "post" : { - "tags" : [ "AnyTypes" ], - "summary" : "Creates a new anyType.", - "operationId" : "create_2", + "tags" : [ "Applications" ], + "summary" : "Creates a new application.", + "operationId" : "create_3", "parameters" : [ { "name" : "X-Syncope-Domain", "in" : "header", @@ -4573,17 +4868,17 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } }, "application/yaml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } }, "application/xml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } } }, @@ -4591,7 +4886,7 @@ }, "responses" : { "201" : { - "description" : "AnyType successfully created", + "description" : "Application successfully created", "headers" : { "X-Syncope-Key" : { "description" : "Key value for the entity created", @@ -4711,15 +5006,15 @@ } ] } }, - "/anyTypes/{key}" : { + "/applications/{key}" : { "get" : { - "tags" : [ "AnyTypes" ], - "summary" : "Returns anyType with matching key.", - "operationId" : "read_5", + "tags" : [ "Applications" ], + "summary" : "Returns application with matching key.", + "operationId" : "read_6", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "anyType key to be read", + "description" : "application key to be read", "required" : true, "schema" : { "type" : "string" @@ -4751,21 +5046,21 @@ } ], "responses" : { "200" : { - "description" : "anyType with matching key", + "description" : "application with matching key", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } }, "application/yaml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } }, "application/xml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } } } @@ -4872,13 +5167,13 @@ } ] }, "put" : { - "tags" : [ "AnyTypes" ], - "summary" : "Updates the anyType matching the provided key.", - "operationId" : "update_3", + "tags" : [ "Applications" ], + "summary" : "Updates the application matching the provided key.", + "operationId" : "update_4", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "AnyType's key", + "description" : "Application's key", "required" : true, "schema" : { "type" : "string" @@ -4912,17 +5207,17 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } }, "application/yaml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } }, "application/xml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/ApplicationTO" } } }, @@ -5034,13 +5329,13 @@ } ] }, "delete" : { - "tags" : [ "AnyTypes" ], - "summary" : "Deletes the anyType matching the provided key.", - "operationId" : "delete_2", + "tags" : [ "Applications" ], + "summary" : "Deletes the application matching the provided key.", + "operationId" : "delete_3", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "anyType key to be deleted", + "description" : "application key to be deleted", "required" : true, "schema" : { "type" : "string" @@ -5176,15 +5471,15 @@ } ] } }, - "/anyTypes/{key}" : { + "/applications/privileges/{key}" : { "get" : { - "tags" : [ "AnyTypes" ], - "summary" : "Returns anyType with matching key.", - "operationId" : "read_5", + "tags" : [ "Applications" ], + "summary" : "Returns privilege with matching key.", + "operationId" : "readPrivilege", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "anyType key to be read", + "description" : "privilege key to be read", "required" : true, "schema" : { "type" : "string" @@ -5216,21 +5511,514 @@ } ], "responses" : { "200" : { - "description" : "anyType with matching key", + "description" : "privilege with matching key", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/PrivilegeTO" } }, "application/yaml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/PrivilegeTO" } }, "application/xml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/PrivilegeTO" + } + } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + } + } + } + }, + "security" : [ { + "BasicAuthentication" : [ ] + }, { + "Bearer" : [ ] + } ] + } + }, + "/attrRepos" : { + "get" : { + "tags" : [ "AttrRepos" ], + "summary" : "Returns a list of attribute repositories.", + "operationId" : "list_4", + "parameters" : [ { + "name" : "X-Syncope-Domain", + "in" : "header", + "required" : true, + "schema" : { + "description" : "Domains are built to facilitate multitenancy.", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; + }, + "default" : "Master", + "enum" : [ "Master", "Two" ] + } + }, { + "name" : "X-Syncope-Delegated-By", + "in" : "header", + "required" : false, + "schema" : { + "description" : "Acton behalf of someone else", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; + } + } + } ], + "responses" : { + "200" : { + "description" : "list of attribute repositories", + "content" : { + "application/json" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + } + }, + "application/yaml" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + } + }, + "application/xml" : { + "schema" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + } + } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + } + } + } + }, + "security" : [ { + "BasicAuthentication" : [ ] + }, { + "Bearer" : [ ] + } ] + }, + "post" : { + "tags" : [ "AttrRepos" ], + "summary" : "Create a new attribute repository.", + "operationId" : "create_4", + "parameters" : [ { + "name" : "X-Syncope-Domain", + "in" : "header", + "required" : true, + "schema" : { + "description" : "Domains are built to facilitate multitenancy.", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; + }, + "default" : "Master", + "enum" : [ "Master", "Two" ] + } + }, { + "name" : "X-Syncope-Delegated-By", + "in" : "header", + "required" : false, + "schema" : { + "description" : "Acton behalf of someone else", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; + } + } + } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + }, + "application/yaml" : { + "schema" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + }, + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + } + }, + "required" : true + }, + "responses" : { + "201" : { + "description" : "AttrRepo successfully created", + "headers" : { + "X-Syncope-Key" : { + "description" : "UUID generated for the entity created", + "style" : "simple", + "schema" : { + "type" : "string" + } + }, + "Location" : { + "description" : "URL of the entity created", + "style" : "simple", + "schema" : { + "type" : "string" + } + } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + } + } + } + }, + "security" : [ { + "BasicAuthentication" : [ ] + }, { + "Bearer" : [ ] + } ] + } + }, + "/attrRepos/{key}" : { + "get" : { + "tags" : [ "AttrRepos" ], + "summary" : "Returns the attribute repository matching the given key.", + "operationId" : "read_7", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "key of requested attribute repository", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "X-Syncope-Domain", + "in" : "header", + "required" : true, + "schema" : { + "description" : "Domains are built to facilitate multitenancy.", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; + }, + "default" : "Master", + "enum" : [ "Master", "Two" ] + } + }, { + "name" : "X-Syncope-Delegated-By", + "in" : "header", + "required" : false, + "schema" : { + "description" : "Acton behalf of someone else", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; + } + } + } ], + "responses" : { + "200" : { + "description" : "attribute repository with matching id", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + }, + "application/yaml" : { + "schema" : { + "$ref" : "#/components/schemas/AttrRepoTO" + } + }, + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/AttrRepoTO" } } } @@ -5337,13 +6125,13 @@ } ] }, "put" : { - "tags" : [ "AnyTypes" ], - "summary" : "Updates the anyType matching the provided key.", - "operationId" : "update_3", + "tags" : [ "AttrRepos" ], + "summary" : "Updates attribute repository matching the given key.", + "operationId" : "update_5", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "AnyType's key", + "description" : "AttrRepo's key", "required" : true, "schema" : { "type" : "string" @@ -5377,17 +6165,17 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/AttrRepoTO" } }, "application/yaml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/AttrRepoTO" } }, "application/xml" : { "schema" : { - "$ref" : "#/components/schemas/AnyTypeTO" + "$ref" : "#/components/schemas/AttrRepoTO" } } }, @@ -5499,13 +6287,13 @@ } ] }, "delete" : { - "tags" : [ "AnyTypes" ], - "summary" : "Deletes the anyType matching the provided key.", - "operationId" : "delete_2", + "tags" : [ "AttrRepos" ], + "summary" : "Delete attribute repository matching the given key.", + "operationId" : "delete_4", "parameters" : [ { "name" : "key", "in" : "path", - "description" : "anyType key to be deleted", + "description" : "key of attribute repository to be deleted", "required" : true, "schema" : { "type" : "string" @@ -5641,11 +6429,253 @@ } ] } }, - "/applications" : { + "/audit/entries" : { "get" : { - "tags" : [ "Applications" ], - "summary" : "Returns a list of all applications.", - "operationId" : "list_3", + "tags" : [ "Audit" ], + "summary" : "Returns a paged list of audit entries matching the given query.", + "operationId" : "search_1", + "parameters" : [ { + "name" : "page", + "in" : "query", + "description" : "page", + "schema" : { + "minimum" : 1, + "type" : "integer", + "format" : "int32", + "default" : 1 + } + }, { + "name" : "size", + "in" : "query", + "description" : "items per page", + "schema" : { + "minimum" : 1, + "type" : "integer", + "format" : "int32", + "default" : 25 + } + }, { + "name" : "orderby", + "in" : "query", + "description" : "sorting conditions", + "schema" : { + "type" : "string", + "example" : "key DESC" + } + }, { + "name" : "before", + "in" : "query", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "after", + "in" : "query", + "schema" : { + "type" : "string", + "format" : "date-time" + } + }, { + "name" : "entityKey", + "in" : "query", + "description" : "audit entity key to match", + "schema" : { + "type" : "string", + "example" : "50592942-73ec-44c4-a377-e859524245e4" + } + }, { + "name" : "type", + "in" : "query", + "description" : "audit type to match", + "schema" : { + "type" : "string", + "enum" : [ "LOGIC", "WA", "TASK", "REPORT", "PROPAGATION", "PULL", "PUSH", "CUSTOM" ] + } + }, { + "name" : "category", + "in" : "query", + "description" : "audit category to match", + "schema" : { + "type" : "string" + } + }, { + "name" : "subcategory", + "in" : "query", + "description" : "audit subcategory to match", + "schema" : { + "type" : "string" + } + }, { + "name" : "events", + "in" : "query", + "description" : "audit events(s) to match", + "schema" : { + "uniqueItems" : true, + "type" : "array", + "items" : { + "type" : "string" + } + } + }, { + "name" : "result", + "in" : "query", + "description" : "audit result to match", + "schema" : { + "type" : "string", + "enum" : [ "SUCCESS", "FAILURE" ] + } + }, { + "name" : "X-Syncope-Domain", + "in" : "header", + "required" : true, + "schema" : { + "description" : "Domains are built to facilitate multitenancy.", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; + }, + "default" : "Master", + "enum" : [ "Master", "Two" ] + } + }, { + "name" : "X-Syncope-Delegated-By", + "in" : "header", + "required" : false, + "schema" : { + "description" : "Acton behalf of someone else", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; + } + } + } ], + "responses" : { + "200" : { + "description" : "paged list of audit entries matching the given query", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/PagedResultAuditEntry" + } + }, + "application/yaml" : { + "schema" : { + "$ref" : "#/components/schemas/PagedResultAuditEntry" + } + }, + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/PagedResultAuditEntry" + } + } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + } + } + } + }, + "security" : [ { + "BasicAuthentication" : [ ] + }, { + "Bearer" : [ ] + } ] + }, + "post" : { + "tags" : [ "Audit" ], + "summary" : "Create an audit entry.", + "operationId" : "create_5", "parameters" : [ { "name" : "X-Syncope-Domain", "in" : "header", @@ -5671,15 +6701,639 @@ } } } ], + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditEntry" + } + }, + "application/yaml" : { + "schema" : { + "$ref" : "#/components/schemas/AuditEntry" + } + }, + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/AuditEntry" + } + } + }, + "required" : true + }, "responses" : { "200" : { - "description" : "list of all applications.", + "description" : "default response", + "content" : { + "*/*" : { } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + } + } + } + }, + "security" : [ { + "BasicAuthentication" : [ ] + }, { + "Bearer" : [ ] + } ] + } + }, + "/audit/{key}" : { + "get" : { + "tags" : [ "Audit" ], + "summary" : "Returns audit with matching key.", + "operationId" : "read_8", + "parameters" : [ { + "name" : "key", + "in" : "path", + "description" : "audit key to be read", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "X-Syncope-Domain", + "in" : "header", + "required" : true, + "schema" : { + "description" : "Domains are built to facilitate multitenancy.", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#domains"; + }, + "default" : "Master", + "enum" : [ "Master", "Two" ] + } + }, { + "name" : "X-Syncope-Delegated-By", + "in" : "header", + "required" : false, + "schema" : { + "description" : "Acton behalf of someone else", + "externalDocs" : { + "description" : "Apache Syncope Reference Guide", + "url" : "https://syncope.apache.org/docs/3.0/reference-guide.html#delegation"; + } + } + } ], + "responses" : { + "200" : { + "description" : "audit with matching key", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/AuditConfTO" + } + }, + "application/yaml" : { + "schema" : { + "$ref" : "#/components/schemas/AuditConfTO" + } + }, + "application/xml" : { + "schema" : { + "$ref" : "#/components/schemas/AuditConfTO" + } + } + } + }, + "400" : { + "description" : "An error occurred; HTTP status code can vary depending on the actual error: 400, 403, 404, 409, 412", + "headers" : { + "X-Application-Error-Code" : { + "description" : "Error code", + "schema" : { + "type" : "string" + } + }, + "X-Application-Error-Info" : { + "description" : "Error message(s)", + "schema" : { + "type" : "string" + } + } + }, + "content" : { + "application/json" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/yaml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string", + "description" : "Error code", + "enum" : [ "AssociatedResources", "Composite", "ConcurrentModification", "ConnectorException", "DataIntegrityViolation", "EntityExists", "GenericPersistence", "InvalidAccessToken", "InvalidPrivilege", "InvalidImplementation", "InvalidImplementationType", "InvalidSecurityAnswer", "InvalidEntity", "InvalidLogger", "InvalidConnInstance", "InvalidConnIdConf", "InvalidPolicy", "InvalidConf", "InvalidPath", "InvalidProvision", "InvalidOrgUnit", "InvalidReport", "InvalidReportExec", "InvalidRelationship", "InvalidRelationshipType", "InvalidAnyType", "InvalidAnyObject", "InvalidGroup", "InvalidSchemaDefinition", "InvalidSearchParameters", "InvalidPageOrSize", "InvalidPropagationTaskExecReport", "InvalidPlainSchema", "InvalidDerSchema", "InvalidVirSchema", "InvalidMapping", "InvalidMembership", "InvalidRealm", "InvalidDynRealm", "InvalidRole", "InvalidUser", "InvalidExternalResource", "InvalidPullTask", "InvalidRequest", "InvalidValues", "NotFound", "RealmContains", "Re quiredValuesMissing", "RESTValidation", "GroupOwnership", "InUse", "Scheduling", "DelegatedAdministration", "Reconciliation", "RunError", "Unknown", "Workflow" ] + }, + "elements" : { + "type" : "string", + "description" : "Error message(s)" + } + }, + "example" : { + "status" : 400, + "type" : "InvalidEntity", + "elements" : [ "error message" ] + } + } + }, + "application/xml" : { + "schema" : { + "properties" : { + "status" : { + "type" : "integer", + "description" : "HTTP status code", + "format" : "int32" + }, + "type" : { + "type" : "string",
[... 51618 lines stripped ...]
