diff --git a/api-server/src/main/java/org/gluu/oxtrust/api/server/api/impl/BaseWebResource.java b/api-server/src/main/java/org/gluu/oxtrust/api/server/api/impl/BaseWebResource.java index 07bbd1fb1..415dbc2ae 100644 --- a/api-server/src/main/java/org/gluu/oxtrust/api/server/api/impl/BaseWebResource.java +++ b/api-server/src/main/java/org/gluu/oxtrust/api/server/api/impl/BaseWebResource.java @@ -12,11 +12,11 @@ @OpenAPIDefinition ( info = @Info ( title = "oxTrust API", - version = "4.0.0", + version = "4.6.0", description = "This is an API for Gluu Server's oxTrust administrative interface. Go to https://gluu.org for more information", - termsOfService = "https://www.gluu.org/terms/", - contact = @Contact(url="https://gluu.org",name="Gluu Support",email="contact@gluu.org"), - license = @License(name = "Gluu Support License", url = "https://www.gluu.org/support-license/") + termsOfService = "https://gluu.org/gluu-terms-and-conditions/", + contact = @Contact(url="https://support.gluu.org/",name="Gluu Support",email="support@gluu.org"), + license = @License(name = "Gluu Support License", url = "https://gluu.org/") ) ) diff --git a/api-server/src/main/resources/META-INF/openapi.json b/api-server/src/main/resources/META-INF/openapi.json index a1078ee09..ba00d7bf3 100644 --- a/api-server/src/main/resources/META-INF/openapi.json +++ b/api-server/src/main/resources/META-INF/openapi.json @@ -3,17 +3,17 @@ "info" : { "title" : "oxTrust API", "description" : "This is an API for Gluu Server's oxTrust administrative interface. Go to https://gluu.org for more information", - "termsOfService" : "https://www.gluu.org/terms/", + "termsOfService" : "https://gluu.org/gluu-terms-and-conditions/", "contact" : { "name" : "Gluu Support", - "url" : "https://gluu.org", - "email" : "contact@gluu.org" + "url" : "https://support.gluu.org/", + "email" : "support@gluu.org" }, "license" : { "name" : "Gluu Support License", - "url" : "https://www.gluu.org/support-license/" + "url" : "https://gluu.org/" }, - "version" : "4.0.0" + "version" : "4.6.0" }, "paths" : { "/configuration/api" : { @@ -616,6 +616,47 @@ } } }, + "/api/v1/clients/search" : { + "get" : { + "summary" : "Search OIDC clients", + "description" : "Search OIDC clients", + "operationId" : "searchClients", + "parameters" : [ { + "name" : "pattern", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "size", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + }, + "security" : [ { + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] + } ] + } + }, "/api/v1/clients/{inum}/scopes" : { "get" : { "summary" : "Get assigned OIDC client scopes", @@ -735,47 +776,6 @@ } ] } }, - "/api/v1/clients/search" : { - "get" : { - "summary" : "Search OIDC clients", - "description" : "Search OIDC clients", - "operationId" : "searchClients", - "parameters" : [ { - "name" : "pattern", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 1 - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - }, - "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] - } ] - } - }, "/api/v1/clients/{inum}/scopes/{sinum}" : { "post" : { "summary" : "Add OIDC client scopes", @@ -1227,11 +1227,11 @@ } } }, - "/api/v1/groups/{inum}/members" : { - "get" : { - "summary" : "Get group members", - "description" : "Get a group members", - "operationId" : "getGroupMembers", + "/api/v1/groups/{inum}/members/{minum}" : { + "post" : { + "summary" : "Add group member", + "description" : "Add group member", + "operationId" : "addGroupMember", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1239,6 +1239,13 @@ "schema" : { "type" : "string" } + }, { + "name" : "minum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -1257,9 +1264,9 @@ } }, "delete" : { - "summary" : "Delete group member", - "description" : "Delete group member", - "operationId" : "deleteGroupMembers", + "summary" : "Remove group member", + "description" : "Remove a member from group", + "operationId" : "removeGroupMember", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1267,22 +1274,29 @@ "schema" : { "type" : "string" } + }, { + "name" : "minum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { - "default" : { - "description" : "default response", - "content" : { - "application/json" : { } - } + "200" : { + "description" : "Success" + }, + "500" : { + "description" : "Server error" } } } }, - "/api/v1/groups/{inum}/members/{minum}" : { - "post" : { - "summary" : "Add group member", - "description" : "Add group member", - "operationId" : "addGroupMember", + "/api/v1/groups/{inum}/members" : { + "get" : { + "summary" : "Get group members", + "description" : "Get a group members", + "operationId" : "getGroupMembers", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1290,13 +1304,6 @@ "schema" : { "type" : "string" } - }, { - "name" : "minum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { @@ -1315,9 +1322,9 @@ } }, "delete" : { - "summary" : "Remove group member", - "description" : "Remove a member from group", - "operationId" : "removeGroupMember", + "summary" : "Delete group member", + "description" : "Delete group member", + "operationId" : "deleteGroupMembers", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1325,20 +1332,13 @@ "schema" : { "type" : "string" } - }, { - "name" : "minum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { - "200" : { - "description" : "Success" - }, - "500" : { - "description" : "Server error" + "default" : { + "description" : "default response", + "content" : { + "application/json" : { } + } } } } @@ -1468,11 +1468,11 @@ } } }, - "/api/v1/configuration/ldap/{name}" : { - "delete" : { - "summary" : "Delete an existing configuration", - "description" : "Delete an existing configuration", - "operationId" : "deleteLdapConfigurationByName", + "/api/v1/configuration/ldap/{name}/status" : { + "get" : { + "summary" : "Check the status of an existing configuration", + "description" : "Check the status of an existing configuration", + "operationId" : "getLdapConfigurationStatusByName", "parameters" : [ { "name" : "name", "in" : "path", @@ -1487,7 +1487,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/ConnectionStatusDTO" } } } @@ -1495,11 +1495,11 @@ } } }, - "/api/v1/configuration/ldap/{name}/status" : { - "get" : { - "summary" : "Check the status of an existing configuration", - "description" : "Check the status of an existing configuration", - "operationId" : "getLdapConfigurationStatusByName", + "/api/v1/configuration/ldap/{name}" : { + "delete" : { + "summary" : "Delete an existing configuration", + "description" : "Delete an existing configuration", + "operationId" : "deleteLdapConfigurationByName", "parameters" : [ { "name" : "name", "in" : "path", @@ -1514,7 +1514,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/ConnectionStatusDTO" + "type" : "string" } } } @@ -2503,43 +2503,6 @@ } } }, - "/api/v1/scopes/search" : { - "get" : { - "summary" : "Search openid connect scopes", - "description" : "Search openid connect scopes", - "operationId" : "searchScope", - "parameters" : [ { - "name" : "pattern", - "in" : "query", - "schema" : { - "type" : "string" - } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 10 - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - } - }, "/api/v1/scopes/{inum}/claims" : { "get" : { "summary" : "Get scope claims", @@ -2570,11 +2533,11 @@ } } }, - "/api/v1/sectoridentifiers/search" : { + "/api/v1/scopes/search" : { "get" : { - "summary" : "Search sector identifiers", - "description" : "Search sectors identifiers", - "operationId" : "searchSectorIdentifier", + "summary" : "Search openid connect scopes", + "description" : "Search openid connect scopes", + "operationId" : "searchScope", "parameters" : [ { "name" : "pattern", "in" : "query", @@ -2687,6 +2650,29 @@ } } }, + "/api/v1/sectoridentifiers/{inum}" : { + "delete" : { + "summary" : "Delete sector identifier", + "description" : "Delete a sector identifier", + "operationId" : "deleteSectorIdentifier", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success" + }, + "500" : { + "description" : "Server error" + } + } + } + }, "/api/v1/sectoridentifiers/sector/{id}" : { "get" : { "summary" : "Get sector identifier", @@ -2717,22 +2703,36 @@ } } }, - "/api/v1/sectoridentifiers/{inum}" : { - "delete" : { - "summary" : "Delete sector identifier", - "description" : "Delete a sector identifier", - "operationId" : "deleteSectorIdentifier", + "/api/v1/sectoridentifiers/search" : { + "get" : { + "summary" : "Search sector identifiers", + "description" : "Search sectors identifiers", + "operationId" : "searchSectorIdentifier", "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, + "name" : "pattern", + "in" : "query", "schema" : { "type" : "string" } + }, { + "name" : "size", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } } ], "responses" : { "200" : { - "description" : "Success" + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } }, "500" : { "description" : "Server error" @@ -2889,9 +2889,11 @@ } } }, - "/api/v1/saml/tr/set_metadata/{inum}" : { - "post" : { - "operationId" : "setMetadata", + "/api/v1/saml/tr/update/{inum}" : { + "put" : { + "summary" : "update TrustRelationship", + "description" : "Update GluuSAMLTrustRelationship.", + "operationId" : "update_1", "parameters" : [ { "name" : "inum", "in" : "path", @@ -2902,22 +2904,23 @@ } ], "requestBody" : { "content" : { - "application/xml" : { - "schema" : { - "type" : "string" - } - }, - "text/plain" : { + "*/*" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" } } - }, - "required" : true + } }, "responses" : { "200" : { - "description" : "OK" + "description" : "OK", + "content" : { + "*/*" : { + "schema" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + } + } + } }, "500" : { "description" : "Server error" @@ -2925,31 +2928,33 @@ } } }, - "/api/v1/saml/tr/remove_attribute" : { - "delete" : { - "operationId" : "removeAttribute", - "requestBody" : { - "content" : { - "text/plain" : { - "schema" : { - "$ref" : "#/components/schemas/GluuAttribute" - } - } - } - }, + "/api/v1/saml/tr/list" : { + "get" : { + "summary" : "list TrustRelationships", + "description" : "List all GluuSAMLTrustRelationship.", + "operationId" : "list", "responses" : { - "default" : { - "description" : "default response", + "200" : { + "description" : "SUCCESS", "content" : { - "text/plain" : { } + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + } + } } + }, + "500" : { + "description" : "Server error" } } } }, - "/api/v1/saml/tr/get_contacts/{inum}" : { + "/api/v1/saml/tr/read/{inum}" : { "get" : { - "operationId" : "getContacts", + "summary" : "read TrustRelationship", + "description" : "Returns a GluuSAMLTrustRelationship by inum", + "operationId" : "read", "parameters" : [ { "name" : "inum", "in" : "path", @@ -2960,11 +2965,11 @@ } ], "responses" : { "200" : { - "description" : "OK", + "description" : "Success", "content" : { - "text/plain" : { + "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" } } } @@ -2975,14 +2980,48 @@ } } }, - "/api/v1/saml/tr/list_all_federations" : { - "get" : { - "operationId" : "listAllFederations", + "/api/v1/saml/tr/delete/{inum}" : { + "delete" : { + "summary" : "delete TrustRelationship", + "description" : "Delete GluuSAMLTrustRelationship.", + "operationId" : "delete", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK" + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/saml/tr/create" : { + "post" : { + "summary" : "create TrustRelationship", + "description" : "Create new GluuSAMLTrustRelationship. Returns inum.", + "operationId" : "create", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + } + } + } + }, "responses" : { "200" : { "description" : "OK", "content" : { - "application/json" : { + "text/plain" : { "schema" : { "type" : "string" } @@ -2995,11 +3034,9 @@ } } }, - "/api/v1/saml/tr/set_certificate/{inum}" : { + "/api/v1/saml/tr/add_attribute/{inum}" : { "post" : { - "summary" : "set certificate for TrustRelationship", - "description" : "Find TrustRelationship by inum and set certificate.", - "operationId" : "setCertificate", + "operationId" : "addAttribute", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3010,12 +3047,13 @@ } ], "requestBody" : { "content" : { - "text/plain" : { + "application/json" : { "schema" : { "type" : "string" } } - } + }, + "required" : true }, "responses" : { "200" : { @@ -3027,9 +3065,31 @@ } } }, - "/api/v1/saml/tr/set_metadata_url/{inum}" : { + "/api/v1/saml/tr/remove_attribute" : { + "delete" : { + "operationId" : "removeAttribute", + "requestBody" : { + "content" : { + "text/plain" : { + "schema" : { + "$ref" : "#/components/schemas/GluuAttribute" + } + } + } + }, + "responses" : { + "default" : { + "description" : "default response", + "content" : { + "text/plain" : { } + } + } + } + } + }, + "/api/v1/saml/tr/set_metadata/{inum}" : { "post" : { - "operationId" : "setMetadataURL", + "operationId" : "setMetadata", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3040,6 +3100,11 @@ } ], "requestBody" : { "content" : { + "application/xml" : { + "schema" : { + "type" : "string" + } + }, "text/plain" : { "schema" : { "type" : "string" @@ -3090,17 +3155,9 @@ } } }, - "/api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}" : { + "/api/v1/saml/tr/list_all_federations" : { "get" : { - "operationId" : "listDeconstructedTrustRelationships", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "operationId" : "listAllFederations", "responses" : { "200" : { "description" : "OK", @@ -3118,29 +3175,9 @@ } } }, - "/api/v1/saml/tr/generate_inum_for_new_trust_relationship" : { - "get" : { - "operationId" : "generateInumForNewTrustRelationship", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "text/plain" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/saml/tr/list_all_other_federations/{inum}" : { - "get" : { - "operationId" : "listAllOtherFederations", + "/api/v1/saml/tr/set_metadata_url/{inum}" : { + "post" : { + "operationId" : "setMetadataURL", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3149,39 +3186,42 @@ "type" : "string" } } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } + "requestBody" : { + "content" : { + "text/plain" : { + "schema" : { + "type" : "string" } } }, + "required" : true + }, + "responses" : { + "200" : { + "description" : "OK" + }, "500" : { "description" : "Server error" } } } }, - "/api/v1/saml/tr/list_all_saml_trust_relationships" : { + "/api/v1/saml/tr/get_contacts/{inum}" : { "get" : { - "operationId" : "listAllSAMLTrustRelationships", + "operationId" : "getContacts", "parameters" : [ { - "name" : "size_limit", - "in" : "query", + "name" : "inum", + "in" : "path", + "required" : true, "schema" : { - "type" : "integer", - "format" : "int32" + "type" : "string" } } ], "responses" : { "200" : { "description" : "OK", "content" : { - "application/json" : { + "text/plain" : { "schema" : { "type" : "string" } @@ -3194,9 +3234,92 @@ } } }, - "/api/v1/saml/tr/list_all_active_trust_relationships" : { + "/api/v1/saml/tr/set_certificate/{inum}" : { + "post" : { + "summary" : "set certificate for TrustRelationship", + "description" : "Find TrustRelationship by inum and set certificate.", + "operationId" : "setCertificate", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "text/plain" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "200" : { + "description" : "OK" + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/saml/tr/generate_configuration_files" : { + "put" : { + "summary" : "generate configuration files", + "description" : "Generate configuration files for Shibboleth IDP", + "operationId" : "generateConfigurationFiles", + "responses" : { + "200" : { + "description" : "OK" + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/saml/tr/list_all_other_federations/{inum}" : { "get" : { - "operationId" : "listAllActiveTrustRelationships", + "operationId" : "listAllOtherFederations", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/saml/tr/list_all_saml_trust_relationships" : { + "get" : { + "operationId" : "listAllSAMLTrustRelationships", + "parameters" : [ { + "name" : "size_limit", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], "responses" : { "200" : { "description" : "OK", @@ -3249,14 +3372,19 @@ } } }, - "/api/v1/saml/tr/generate_configuration_files" : { - "put" : { - "summary" : "generate configuration files", - "description" : "Generate configuration files for Shibboleth IDP", - "operationId" : "generateConfigurationFiles", + "/api/v1/saml/tr/list_all_active_trust_relationships" : { + "get" : { + "operationId" : "listAllActiveTrustRelationships", "responses" : { "200" : { - "description" : "OK" + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } }, "500" : { "description" : "Server error" @@ -3264,11 +3392,9 @@ } } }, - "/api/v1/saml/tr/update/{inum}" : { - "put" : { - "summary" : "update TrustRelationship", - "description" : "Update GluuSAMLTrustRelationship.", - "operationId" : "update_1", + "/api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}" : { + "get" : { + "operationId" : "listDeconstructedTrustRelationships", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3277,22 +3403,13 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "*/*" : { - "schema" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" - } - } - } - }, "responses" : { "200" : { "description" : "OK", "content" : { - "*/*" : { + "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + "type" : "string" } } } @@ -3303,18 +3420,16 @@ } } }, - "/api/v1/saml/tr/list" : { + "/api/v1/saml/tr/generate_inum_for_new_trust_relationship" : { "get" : { - "summary" : "list TrustRelationships", - "description" : "List all GluuSAMLTrustRelationship.", - "operationId" : "list", + "operationId" : "generateInumForNewTrustRelationship", "responses" : { "200" : { - "description" : "SUCCESS", + "description" : "OK", "content" : { - "application/json" : { + "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + "type" : "string" } } } @@ -3325,11 +3440,11 @@ } } }, - "/api/v1/saml/tr/read/{inum}" : { + "/api/v1/inbound-saml/trusted-idp/inum/{inum}" : { "get" : { - "summary" : "read TrustRelationship", - "description" : "Returns a GluuSAMLTrustRelationship by inum", - "operationId" : "read", + "summary" : "Get TrustedIDP by inum", + "description" : "Get a TrustedIDP by inum", + "operationId" : "gluuTrustedIdp", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3344,33 +3459,13 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + "$ref" : "#/components/schemas/TrustedIDPApi" } } } }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/saml/tr/delete/{inum}" : { - "delete" : { - "summary" : "delete TrustRelationship", - "description" : "Delete GluuSAMLTrustRelationship.", - "operationId" : "delete", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "OK" + "404" : { + "description" : "Resource not Found" }, "500" : { "description" : "Server error" @@ -3378,25 +3473,16 @@ } } }, - "/api/v1/saml/tr/create" : { - "post" : { - "summary" : "create TrustRelationship", - "description" : "Create new GluuSAMLTrustRelationship. Returns inum.", - "operationId" : "create", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" - } - } - } - }, + "/api/v1/inbound-saml/trusted-idp" : { + "get" : { + "summary" : "Retrieve all trusted-idps", + "description" : "Retrieve all trusted-idps", + "operationId" : "gluuTrustedIdps", "responses" : { "200" : { - "description" : "OK", + "description" : "Success", "content" : { - "text/plain" : { + "application/json" : { "schema" : { "type" : "string" } @@ -3407,54 +3493,22 @@ "description" : "Server error" } } - } - }, - "/api/v1/saml/tr/add_attribute/{inum}" : { + }, "post" : { - "operationId" : "addAttribute", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "summary" : "Add TrustedIDP", + "description" : "Add an TrustedIDP", + "operationId" : "createGluuTrustedIdp", "requestBody" : { "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/TrustedIDPApi" } } - }, - "required" : true - }, - "responses" : { - "200" : { - "description" : "OK" - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/inbound-saml/trusted-idp/inum/{inum}" : { - "get" : { - "summary" : "Get TrustedIDP by inum", - "description" : "Get a TrustedIDP by inum", - "operationId" : "gluuTrustedIdp", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" } - } ], + }, "responses" : { - "200" : { + "201" : { "description" : "Success", "content" : { "application/json" : { @@ -3464,8 +3518,8 @@ } } }, - "404" : { - "description" : "Resource not Found" + "403" : { + "description" : "Trust Relation already exists" }, "500" : { "description" : "Server error" @@ -3567,60 +3621,6 @@ } } }, - "/api/v1/inbound-saml/trusted-idp" : { - "get" : { - "summary" : "Retrieve all trusted-idps", - "description" : "Retrieve all trusted-idps", - "operationId" : "gluuTrustedIdps", - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - }, - "post" : { - "summary" : "Add TrustedIDP", - "description" : "Add an TrustedIDP", - "operationId" : "createGluuTrustedIdp", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/TrustedIDPApi" - } - } - } - }, - "responses" : { - "201" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/TrustedIDPApi" - } - } - } - }, - "403" : { - "description" : "Trust Relation already exists" - }, - "500" : { - "description" : "Server error" - } - } - } - }, "/api/v1/uma/resources" : { "get" : { "summary" : "Get UMA resources", @@ -3701,44 +3701,6 @@ } } }, - "/api/v1/uma/resources/search" : { - "get" : { - "summary" : "Search UMA resources", - "description" : "Search uma resources", - "operationId" : "searchUmaResources", - "parameters" : [ { - "name" : "pattern", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "size", - "in" : "query", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int32" - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - } - }, "/api/v1/uma/resources/{id}" : { "get" : { "summary" : "Get UMA resource by id", @@ -3790,6 +3752,44 @@ } } }, + "/api/v1/uma/resources/search" : { + "get" : { + "summary" : "Search UMA resources", + "description" : "Search uma resources", + "operationId" : "searchUmaResources", + "parameters" : [ { + "name" : "pattern", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "size", + "in" : "query", + "required" : true, + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, "/api/v1/uma/resources/{id}/clients/{inum}" : { "post" : { "summary" : "Add UMA resource client", @@ -3862,6 +3862,29 @@ } } }, + "/api/v1/uma/resources/{id}/clients" : { + "get" : { + "summary" : "Get clients of UMA resources", + "description" : "Get clients of uma resource", + "operationId" : "getUmaResourceClients", + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "description" : "default response", + "content" : { + "application/json" : { } + } + } + } + } + }, "/api/v1/uma/resources/{id}/scopes" : { "get" : { "summary" : "Get UMA resource scopes", @@ -3957,13 +3980,13 @@ } } }, - "/api/v1/uma/resources/{id}/clients" : { + "/api/v1/uma/scopes/{inum}" : { "get" : { - "summary" : "Get clients of UMA resources", - "description" : "Get clients of uma resource", - "operationId" : "getUmaResourceClients", + "summary" : "Get UMA scope by inum", + "description" : "Get a uma scope by inum", + "operationId" : "getUmaScopeByInum", "parameters" : [ { - "name" : "id", + "name" : "inum", "in" : "path", "required" : true, "schema" : { @@ -3971,11 +3994,39 @@ } } ], "responses" : { - "default" : { - "description" : "default response", + "200" : { + "description" : "success", "content" : { - "application/json" : { } + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Scope" + } + } } + }, + "500" : { + "description" : "Server error" + } + } + }, + "delete" : { + "summary" : "Delete UMA scope", + "description" : "Delete a uma scope", + "operationId" : "deleteUmaScope", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "success" + }, + "500" : { + "description" : "Server error" } } } @@ -4060,57 +4111,6 @@ } } }, - "/api/v1/uma/scopes/{inum}" : { - "get" : { - "summary" : "Get UMA scope by inum", - "description" : "Get a uma scope by inum", - "operationId" : "getUmaScopeByInum", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Scope" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - }, - "delete" : { - "summary" : "Delete UMA scope", - "description" : "Delete a uma scope", - "operationId" : "deleteUmaScope", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "success" - }, - "500" : { - "description" : "Server error" - } - } - } - }, "/api/v1/uma/scopes/search" : { "get" : { "summary" : "Search UMA scopes", @@ -4517,22 +4517,22 @@ "whitePagesCanView" : { "type" : "boolean" }, - "adminCanAccess" : { + "userCanView" : { "type" : "boolean" }, - "userCanAccess" : { + "userCanEdit" : { "type" : "boolean" }, - "adminCanEdit" : { + "userCanAccess" : { "type" : "boolean" }, - "adminCanView" : { + "adminCanAccess" : { "type" : "boolean" }, - "userCanView" : { + "adminCanView" : { "type" : "boolean" }, - "userCanEdit" : { + "adminCanEdit" : { "type" : "boolean" }, "baseDn" : { @@ -7516,47 +7516,6 @@ } } }, - "TrustContact" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "phone" : { - "type" : "string" - }, - "mail" : { - "type" : "string" - }, - "title" : { - "type" : "string" - } - } - }, - "SAMLTrustRelationshipShort" : { - "type" : "object", - "properties" : { - "inum" : { - "type" : "string" - }, - "displayName" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "validationStatus" : { - "type" : "string", - "enum" : [ "In Progress", "Success", "Scheduled", "Failed" ] - }, - "releasedAttributes" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, "GluuCustomAttribute" : { "type" : "object", "properties" : { @@ -7582,45 +7541,45 @@ "enum" : [ "disabled", "enabled", "false", "true", "inactive", "active" ] } }, + "displayValue" : { + "type" : "object" + }, "booleanValue" : { "type" : "string", "enum" : [ "disabled", "enabled", "false", "true", "inactive", "active" ] }, - "value" : { - "type" : "object" - }, "multiValued" : { "type" : "boolean" }, "new" : { "type" : "boolean" }, - "stringValues" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "stringValue" : { - "type" : "string" + "userCanView" : { + "type" : "boolean" }, - "adminCanAccess" : { + "userCanEdit" : { "type" : "boolean" }, "userCanAccess" : { "type" : "boolean" }, - "adminCanEdit" : { + "adminCanAccess" : { "type" : "boolean" }, "adminCanView" : { "type" : "boolean" }, - "userCanView" : { + "adminCanEdit" : { "type" : "boolean" }, - "userCanEdit" : { - "type" : "boolean" + "stringValues" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "stringValue" : { + "type" : "string" } } }, @@ -7758,19 +7717,10 @@ "certificate" : { "type" : "string" }, - "specificRelyingPartyConfig" : { - "type" : "boolean" - }, - "containerFederation" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" - }, - "fileMetadataSourceType" : { - "type" : "boolean" - }, - "uriMetadataSourceType" : { - "type" : "boolean" + "entityId" : { + "type" : "string" }, - "mdqMetadataSourceType" : { + "federation" : { "type" : "boolean" }, "mdqFederation" : { @@ -7779,12 +7729,6 @@ "researchBundle" : { "type" : "boolean" }, - "entityId" : { - "type" : "string" - }, - "federation" : { - "type" : "boolean" - }, "uniqueGluuEntityId" : { "uniqueItems" : true, "type" : "array", @@ -7793,6 +7737,21 @@ "type" : "string" } }, + "containerFederation" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + }, + "specificRelyingPartyConfig" : { + "type" : "boolean" + }, + "uriMetadataSourceType" : { + "type" : "boolean" + }, + "fileMetadataSourceType" : { + "type" : "boolean" + }, + "mdqMetadataSourceType" : { + "type" : "boolean" + }, "baseDn" : { "type" : "string" } @@ -7899,6 +7858,47 @@ } } }, + "SAMLTrustRelationshipShort" : { + "type" : "object", + "properties" : { + "inum" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "validationStatus" : { + "type" : "string", + "enum" : [ "In Progress", "Success", "Scheduled", "Failed" ] + }, + "releasedAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, + "TrustContact" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "phone" : { + "type" : "string" + }, + "mail" : { + "type" : "string" + }, + "title" : { + "type" : "string" + } + } + }, "RemoteIdp" : { "type" : "object", "properties" : { diff --git a/api-server/src/main/resources/META-INF/openapi.yaml b/api-server/src/main/resources/META-INF/openapi.yaml index 37269f728..29a6d9d15 100644 --- a/api-server/src/main/resources/META-INF/openapi.yaml +++ b/api-server/src/main/resources/META-INF/openapi.yaml @@ -3,15 +3,15 @@ info: title: oxTrust API description: This is an API for Gluu Server's oxTrust administrative interface. Go to https://gluu.org for more information - termsOfService: https://www.gluu.org/terms/ + termsOfService: https://gluu.org/gluu-terms-and-conditions/ contact: name: Gluu Support - url: https://gluu.org - email: contact@gluu.org + url: https://support.gluu.org/ + email: support@gluu.org license: name: Gluu Support License - url: https://www.gluu.org/support-license/ - version: 4.0.0 + url: https://gluu.org/ + version: 4.6.0 paths: /configuration/api: get: @@ -417,6 +417,35 @@ paths: description: default response content: application/json: {} + /api/v1/clients/search: + get: + summary: Search OIDC clients + description: Search OIDC clients + operationId: searchClients + parameters: + - name: pattern + in: query + required: true + schema: + type: string + - name: size + in: query + schema: + type: integer + format: int32 + default: 1 + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.client.read /api/v1/clients/{inum}/scopes: get: summary: Get assigned OIDC client scopes @@ -500,35 +529,6 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.client.write - /api/v1/clients/search: - get: - summary: Search OIDC clients - description: Search OIDC clients - operationId: searchClients - parameters: - - name: pattern - in: query - required: true - schema: - type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 1 - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.client.read /api/v1/clients/{inum}/scopes/{sinum}: post: summary: Add OIDC client scopes @@ -833,17 +833,22 @@ paths: type: string 500: description: Server error - /api/v1/groups/{inum}/members: - get: - summary: Get group members - description: Get a group members - operationId: getGroupMembers + /api/v1/groups/{inum}/members/{minum}: + post: + summary: Add group member + description: Add group member + operationId: addGroupMember parameters: - name: inum in: path required: true schema: type: string + - name: minum + in: path + required: true + schema: + type: string responses: 200: description: Success @@ -854,32 +859,32 @@ paths: 500: description: Server error delete: - summary: Delete group member - description: Delete group member - operationId: deleteGroupMembers + summary: Remove group member + description: Remove a member from group + operationId: removeGroupMember parameters: - name: inum in: path required: true schema: type: string - responses: - default: - description: default response - content: - application/json: {} - /api/v1/groups/{inum}/members/{minum}: - post: - summary: Add group member - description: Add group member - operationId: addGroupMember - parameters: - - name: inum + - name: minum in: path required: true schema: type: string - - name: minum + responses: + 200: + description: Success + 500: + description: Server error + /api/v1/groups/{inum}/members: + get: + summary: Get group members + description: Get a group members + operationId: getGroupMembers + parameters: + - name: inum in: path required: true schema: @@ -894,25 +899,20 @@ paths: 500: description: Server error delete: - summary: Remove group member - description: Remove a member from group - operationId: removeGroupMember + summary: Delete group member + description: Delete group member + operationId: deleteGroupMembers parameters: - name: inum in: path required: true schema: type: string - - name: minum - in: path - required: true - schema: - type: string responses: - 200: - description: Success - 500: - description: Server error + default: + description: default response + content: + application/json: {} /configuration/idp: get: summary: Retrieve idp configuration @@ -991,11 +991,11 @@ paths: application/json: schema: $ref: '#/components/schemas/LdapConfigurationDTO' - /api/v1/configuration/ldap/{name}: - delete: - summary: Delete an existing configuration - description: Delete an existing configuration - operationId: deleteLdapConfigurationByName + /api/v1/configuration/ldap/{name}/status: + get: + summary: Check the status of an existing configuration + description: Check the status of an existing configuration + operationId: getLdapConfigurationStatusByName parameters: - name: name in: path @@ -1008,12 +1008,12 @@ paths: content: application/json: schema: - type: string - /api/v1/configuration/ldap/{name}/status: - get: - summary: Check the status of an existing configuration - description: Check the status of an existing configuration - operationId: getLdapConfigurationStatusByName + $ref: '#/components/schemas/ConnectionStatusDTO' + /api/v1/configuration/ldap/{name}: + delete: + summary: Delete an existing configuration + description: Delete an existing configuration + operationId: deleteLdapConfigurationByName parameters: - name: name in: path @@ -1026,7 +1026,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ConnectionStatusDTO' + type: string /api/v1/configuration/ldap/status: post: summary: Check status of a configuration @@ -1652,31 +1652,6 @@ paths: description: Success 500: description: Server error - /api/v1/scopes/search: - get: - summary: Search openid connect scopes - description: Search openid connect scopes - operationId: searchScope - parameters: - - name: pattern - in: query - schema: - type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 10 - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error /api/v1/scopes/{inum}/claims: get: summary: Get scope claims @@ -1697,11 +1672,11 @@ paths: type: string 500: description: Server error - /api/v1/sectoridentifiers/search: + /api/v1/scopes/search: get: - summary: Search sector identifiers - description: Search sectors identifiers - operationId: searchSectorIdentifier + summary: Search openid connect scopes + description: Search openid connect scopes + operationId: searchScope parameters: - name: pattern in: query @@ -1772,6 +1747,22 @@ paths: $ref: '#/components/schemas/OxAuthSectorIdentifier' 500: description: Server error + /api/v1/sectoridentifiers/{inum}: + delete: + summary: Delete sector identifier + description: Delete a sector identifier + operationId: deleteSectorIdentifier + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + 500: + description: Server error /api/v1/sectoridentifiers/sector/{id}: get: summary: Get sector identifier @@ -1792,20 +1783,29 @@ paths: $ref: '#/components/schemas/OxAuthSectorIdentifier' 500: description: Server error - /api/v1/sectoridentifiers/{inum}: - delete: - summary: Delete sector identifier - description: Delete a sector identifier - operationId: deleteSectorIdentifier + /api/v1/sectoridentifiers/search: + get: + summary: Search sector identifiers + description: Search sectors identifiers + operationId: searchSectorIdentifier parameters: - - name: inum - in: path - required: true + - name: pattern + in: query schema: type: string + - name: size + in: query + schema: + type: integer + format: int32 + default: 10 responses: 200: description: Success + content: + application/json: + schema: + type: string 500: description: Server error /api/v1/configuration/status: @@ -1902,9 +1902,11 @@ paths: $ref: '#/components/schemas/SystemConfig' 500: description: Server error - /api/v1/saml/tr/set_metadata/{inum}: - post: - operationId: setMetadata + /api/v1/saml/tr/update/{inum}: + put: + summary: update TrustRelationship + description: Update GluuSAMLTrustRelationship. + operationId: update_1 parameters: - name: inum in: path @@ -1913,34 +1915,37 @@ paths: type: string requestBody: content: - application/xml: - schema: - type: string - text/plain: + '*/*': schema: - type: string - required: true + $ref: '#/components/schemas/GluuSAMLTrustRelationship' responses: 200: description: OK + content: + '*/*': + schema: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' 500: description: Server error - /api/v1/saml/tr/remove_attribute: - delete: - operationId: removeAttribute - requestBody: - content: - text/plain: - schema: - $ref: '#/components/schemas/GluuAttribute' + /api/v1/saml/tr/list: + get: + summary: list TrustRelationships + description: List all GluuSAMLTrustRelationship. + operationId: list responses: - default: - description: default response + 200: + description: SUCCESS content: - text/plain: {} - /api/v1/saml/tr/get_contacts/{inum}: + application/json: + schema: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' + 500: + description: Server error + /api/v1/saml/tr/read/{inum}: get: - operationId: getContacts + summary: read TrustRelationship + description: Returns a GluuSAMLTrustRelationship by inum + operationId: read parameters: - name: inum in: path @@ -1949,30 +1954,51 @@ paths: type: string responses: 200: - description: OK + description: Success content: - text/plain: + application/json: schema: - type: string + $ref: '#/components/schemas/GluuSAMLTrustRelationship' 500: description: Server error - /api/v1/saml/tr/list_all_federations: - get: - operationId: listAllFederations + /api/v1/saml/tr/delete/{inum}: + delete: + summary: delete TrustRelationship + description: Delete GluuSAMLTrustRelationship. + operationId: delete + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: OK + 500: + description: Server error + /api/v1/saml/tr/create: + post: + summary: create TrustRelationship + description: Create new GluuSAMLTrustRelationship. Returns inum. + operationId: create + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' responses: 200: description: OK content: - application/json: + text/plain: schema: type: string 500: description: Server error - /api/v1/saml/tr/set_certificate/{inum}: + /api/v1/saml/tr/add_attribute/{inum}: post: - summary: set certificate for TrustRelationship - description: Find TrustRelationship by inum and set certificate. - operationId: setCertificate + operationId: addAttribute parameters: - name: inum in: path @@ -1981,17 +2007,31 @@ paths: type: string requestBody: content: - text/plain: + application/json: schema: type: string + required: true responses: 200: description: OK 500: description: Server error - /api/v1/saml/tr/set_metadata_url/{inum}: + /api/v1/saml/tr/remove_attribute: + delete: + operationId: removeAttribute + requestBody: + content: + text/plain: + schema: + $ref: '#/components/schemas/GluuAttribute' + responses: + default: + description: default response + content: + text/plain: {} + /api/v1/saml/tr/set_metadata/{inum}: post: - operationId: setMetadataURL + operationId: setMetadata parameters: - name: inum in: path @@ -2000,6 +2040,9 @@ paths: type: string requestBody: content: + application/xml: + schema: + type: string text/plain: schema: type: string @@ -2031,27 +2074,47 @@ paths: description: OK 500: description: Server error - /api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}: + /api/v1/saml/tr/list_all_federations: get: - operationId: listDeconstructedTrustRelationships + operationId: listAllFederations + responses: + 200: + description: OK + content: + application/json: + schema: + type: string + 500: + description: Server error + /api/v1/saml/tr/set_metadata_url/{inum}: + post: + operationId: setMetadataURL parameters: - name: inum in: path required: true schema: type: string + requestBody: + content: + text/plain: + schema: + type: string + required: true responses: 200: description: OK - content: - application/json: - schema: - type: string 500: description: Server error - /api/v1/saml/tr/generate_inum_for_new_trust_relationship: + /api/v1/saml/tr/get_contacts/{inum}: get: - operationId: generateInumForNewTrustRelationship + operationId: getContacts + parameters: + - name: inum + in: path + required: true + schema: + type: string responses: 200: description: OK @@ -2061,6 +2124,37 @@ paths: type: string 500: description: Server error + /api/v1/saml/tr/set_certificate/{inum}: + post: + summary: set certificate for TrustRelationship + description: Find TrustRelationship by inum and set certificate. + operationId: setCertificate + parameters: + - name: inum + in: path + required: true + schema: + type: string + requestBody: + content: + text/plain: + schema: + type: string + responses: + 200: + description: OK + 500: + description: Server error + /api/v1/saml/tr/generate_configuration_files: + put: + summary: generate configuration files + description: Generate configuration files for Shibboleth IDP + operationId: generateConfigurationFiles + responses: + 200: + description: OK + 500: + description: Server error /api/v1/saml/tr/list_all_other_federations/{inum}: get: operationId: listAllOtherFederations @@ -2097,18 +2191,6 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/list_all_active_trust_relationships: - get: - operationId: listAllActiveTrustRelationships - responses: - 200: - description: OK - content: - application/json: - schema: - type: string - 500: - description: Server error /api/v1/saml/tr/search_trust_relationships: get: operationId: searchTrustRelationships @@ -2132,60 +2214,53 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/generate_configuration_files: - put: - summary: generate configuration files - description: Generate configuration files for Shibboleth IDP - operationId: generateConfigurationFiles + /api/v1/saml/tr/list_all_active_trust_relationships: + get: + operationId: listAllActiveTrustRelationships responses: 200: description: OK + content: + application/json: + schema: + type: string 500: description: Server error - /api/v1/saml/tr/update/{inum}: - put: - summary: update TrustRelationship - description: Update GluuSAMLTrustRelationship. - operationId: update_1 + /api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}: + get: + operationId: listDeconstructedTrustRelationships parameters: - name: inum in: path required: true schema: type: string - requestBody: - content: - '*/*': - schema: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' responses: 200: description: OK content: - '*/*': + application/json: schema: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' + type: string 500: description: Server error - /api/v1/saml/tr/list: + /api/v1/saml/tr/generate_inum_for_new_trust_relationship: get: - summary: list TrustRelationships - description: List all GluuSAMLTrustRelationship. - operationId: list + operationId: generateInumForNewTrustRelationship responses: 200: - description: SUCCESS + description: OK content: - application/json: + text/plain: schema: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' + type: string 500: description: Server error - /api/v1/saml/tr/read/{inum}: + /api/v1/inbound-saml/trusted-idp/inum/{inum}: get: - summary: read TrustRelationship - description: Returns a GluuSAMLTrustRelationship by inum - operationId: read + summary: Get TrustedIDP by inum + description: Get a TrustedIDP by inum + operationId: gluuTrustedIdp parameters: - name: inum in: path @@ -2198,84 +2273,43 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' - 500: - description: Server error - /api/v1/saml/tr/delete/{inum}: - delete: - summary: delete TrustRelationship - description: Delete GluuSAMLTrustRelationship. - operationId: delete - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: OK + $ref: '#/components/schemas/TrustedIDPApi' + 404: + description: Resource not Found 500: description: Server error - /api/v1/saml/tr/create: - post: - summary: create TrustRelationship - description: Create new GluuSAMLTrustRelationship. Returns inum. - operationId: create - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' + /api/v1/inbound-saml/trusted-idp: + get: + summary: Retrieve all trusted-idps + description: Retrieve all trusted-idps + operationId: gluuTrustedIdps responses: 200: - description: OK + description: Success content: - text/plain: + application/json: schema: type: string 500: description: Server error - /api/v1/saml/tr/add_attribute/{inum}: post: - operationId: addAttribute - parameters: - - name: inum - in: path - required: true - schema: - type: string + summary: Add TrustedIDP + description: Add an TrustedIDP + operationId: createGluuTrustedIdp requestBody: content: application/json: schema: - type: string - required: true - responses: - 200: - description: OK - 500: - description: Server error - /api/v1/inbound-saml/trusted-idp/inum/{inum}: - get: - summary: Get TrustedIDP by inum - description: Get a TrustedIDP by inum - operationId: gluuTrustedIdp - parameters: - - name: inum - in: path - required: true - schema: - type: string + $ref: '#/components/schemas/TrustedIDPApi' responses: - 200: + 201: description: Success content: application/json: schema: $ref: '#/components/schemas/TrustedIDPApi' - 404: - description: Resource not Found + 403: + description: Trust Relation already exists 500: description: Server error /api/v1/inbound-saml/trusted-idp/{remoteIdpHost}: @@ -2341,40 +2375,6 @@ paths: description: Success 500: description: Server error - /api/v1/inbound-saml/trusted-idp: - get: - summary: Retrieve all trusted-idps - description: Retrieve all trusted-idps - operationId: gluuTrustedIdps - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error - post: - summary: Add TrustedIDP - description: Add an TrustedIDP - operationId: createGluuTrustedIdp - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/TrustedIDPApi' - responses: - 201: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/TrustedIDPApi' - 403: - description: Trust Relation already exists - 500: - description: Server error /api/v1/uma/resources: get: summary: Get UMA resources @@ -2396,59 +2396,33 @@ paths: requestBody: content: application/json: - schema: - $ref: '#/components/schemas/UmaResource' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' - 500: - description: Server error - post: - summary: Add new UMA resource - description: Add new uma resource - operationId: createUmaResource - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' - 500: - description: Server error - /api/v1/uma/resources/search: - get: - summary: Search UMA resources - description: Search uma resources - operationId: searchUmaResources - parameters: - - name: pattern - in: query - required: true - schema: - type: string - - name: size - in: query - required: true - schema: - type: integer - format: int32 + schema: + $ref: '#/components/schemas/UmaResource' responses: 200: description: Success content: application/json: schema: - type: string + $ref: '#/components/schemas/UmaResource' + 500: + description: Server error + post: + summary: Add new UMA resource + description: Add new uma resource + operationId: createUmaResource + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' 500: description: Server error /api/v1/uma/resources/{id}: @@ -2486,6 +2460,32 @@ paths: description: Success 500: description: Server error + /api/v1/uma/resources/search: + get: + summary: Search UMA resources + description: Search uma resources + operationId: searchUmaResources + parameters: + - name: pattern + in: query + required: true + schema: + type: string + - name: size + in: query + required: true + schema: + type: integer + format: int32 + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error /api/v1/uma/resources/{id}/clients/{inum}: post: summary: Add UMA resource client @@ -2535,6 +2535,22 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error + /api/v1/uma/resources/{id}/clients: + get: + summary: Get clients of UMA resources + description: Get clients of uma resource + operationId: getUmaResourceClients + parameters: + - name: id + in: path + required: true + schema: + type: string + responses: + default: + description: default response + content: + application/json: {} /api/v1/uma/resources/{id}/scopes: get: summary: Get UMA resource scopes @@ -2600,22 +2616,41 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error - /api/v1/uma/resources/{id}/clients: + /api/v1/uma/scopes/{inum}: get: - summary: Get clients of UMA resources - description: Get clients of uma resource - operationId: getUmaResourceClients + summary: Get UMA scope by inum + description: Get a uma scope by inum + operationId: getUmaScopeByInum parameters: - - name: id + - name: inum in: path required: true schema: type: string responses: - default: - description: default response + 200: + description: success content: - application/json: {} + application/json: + schema: + $ref: '#/components/schemas/Scope' + 500: + description: Server error + delete: + summary: Delete UMA scope + description: Delete a uma scope + operationId: deleteUmaScope + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: success + 500: + description: Server error /api/v1/uma/scopes: get: summary: Get UMA scopes @@ -2666,41 +2701,6 @@ paths: $ref: '#/components/schemas/Scope' 500: description: Server error - /api/v1/uma/scopes/{inum}: - get: - summary: Get UMA scope by inum - description: Get a uma scope by inum - operationId: getUmaScopeByInum - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: success - content: - application/json: - schema: - $ref: '#/components/schemas/Scope' - 500: - description: Server error - delete: - summary: Delete UMA scope - description: Delete a uma scope - operationId: deleteUmaScope - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: success - 500: - description: Server error /api/v1/uma/scopes/search: get: summary: Search UMA scopes @@ -3000,17 +3000,17 @@ components: type: string whitePagesCanView: type: boolean - adminCanAccess: + userCanView: + type: boolean + userCanEdit: type: boolean userCanAccess: type: boolean - adminCanEdit: + adminCanAccess: type: boolean adminCanView: type: boolean - userCanView: - type: boolean - userCanEdit: + adminCanEdit: type: boolean baseDn: type: string @@ -5228,37 +5228,6 @@ components: type: string allowProfileManagement: type: string - TrustContact: - type: object - properties: - name: - type: string - phone: - type: string - mail: - type: string - title: - type: string - SAMLTrustRelationshipShort: - type: object - properties: - inum: - type: string - displayName: - type: string - description: - type: string - validationStatus: - type: string - enum: - - In Progress - - Success - - Scheduled - - Failed - releasedAttributes: - type: array - items: - type: string GluuCustomAttribute: type: object properties: @@ -5283,6 +5252,8 @@ components: - "true" - inactive - active + displayValue: + type: object booleanValue: type: string enum: @@ -5292,30 +5263,28 @@ components: - "true" - inactive - active - value: - type: object multiValued: type: boolean new: type: boolean - stringValues: - type: array - items: - type: string - stringValue: - type: string - adminCanAccess: + userCanView: + type: boolean + userCanEdit: type: boolean userCanAccess: type: boolean - adminCanEdit: + adminCanAccess: type: boolean adminCanView: type: boolean - userCanView: - type: boolean - userCanEdit: + adminCanEdit: type: boolean + stringValues: + type: array + items: + type: string + stringValue: + type: string GluuSAMLTrustRelationship: required: - description @@ -5428,30 +5397,30 @@ components: type: string certificate: type: string - specificRelyingPartyConfig: - type: boolean - containerFederation: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' - fileMetadataSourceType: - type: boolean - uriMetadataSourceType: - type: boolean - mdqMetadataSourceType: + entityId: + type: string + federation: type: boolean mdqFederation: type: boolean researchBundle: type: boolean - entityId: - type: string - federation: - type: boolean uniqueGluuEntityId: uniqueItems: true type: array writeOnly: true items: type: string + containerFederation: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' + specificRelyingPartyConfig: + type: boolean + uriMetadataSourceType: + type: boolean + fileMetadataSourceType: + type: boolean + mdqMetadataSourceType: + type: boolean baseDn: type: string writeOnly: true @@ -5522,6 +5491,37 @@ components: type: array items: type: string + SAMLTrustRelationshipShort: + type: object + properties: + inum: + type: string + displayName: + type: string + description: + type: string + validationStatus: + type: string + enum: + - In Progress + - Success + - Scheduled + - Failed + releasedAttributes: + type: array + items: + type: string + TrustContact: + type: object + properties: + name: + type: string + phone: + type: string + mail: + type: string + title: + type: string RemoteIdp: type: object properties: