From 423c6ba193223fbf3521b5c868d5d815a5b29adf Mon Sep 17 00:00:00 2001 From: shekhar16 Date: Fri, 24 Nov 2023 01:25:01 +0530 Subject: [PATCH] feat(oxtrust-api-server): #2380 updated doc details --- .../api/server/api/impl/BaseWebResource.java | 8 +- .../src/main/resources/META-INF/openapi.json | 1600 ++++++++--------- .../src/main/resources/META-INF/openapi.yaml | 1132 ++++++------ 3 files changed, 1370 insertions(+), 1370 deletions(-) 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..7b9980566 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.5.0.sp1", 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 b8ac8fc87..06b846830 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.5.0.sp1" }, "paths" : { "/configuration/api" : { @@ -173,6 +173,35 @@ } } }, + "/api/v1/attributes/{inum}" : { + "delete" : { + "summary" : "Delete gluu attribute", + "description" : "Deletes a gluu attribute", + "operationId" : "deleteAttribute", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "success" + }, + "404" : { + "description" : "Not found" + }, + "500" : { + "description" : "Server error" + } + }, + "security" : [ { + "oauth2" : [ "https://gluu.org/auth/oxtrust.attribute.write" ] + } ] + } + }, "/api/v1/attributes/search" : { "get" : { "summary" : "Search attributes", @@ -214,35 +243,6 @@ } ] } }, - "/api/v1/attributes/{inum}" : { - "delete" : { - "summary" : "Delete gluu attribute", - "description" : "Deletes a gluu attribute", - "operationId" : "deleteAttribute", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "success" - }, - "404" : { - "description" : "Not found" - }, - "500" : { - "description" : "Server error" - } - }, - "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.attribute.write" ] - } ] - } - }, "/api/v1/attributes/attribute/{inum}" : { "get" : { "summary" : "Get attribute by inum", @@ -616,6 +616,70 @@ } } }, + "/api/v1/clients/{inum}" : { + "get" : { + "summary" : "Get OIDC client", + "description" : "Get a specific OIDC client", + "operationId" : "getClientByInum", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OxAuthClient" + } + } + } + }, + "500" : { + "description" : "Server error" + } + }, + "security" : [ { + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] + } ] + }, + "delete" : { + "summary" : "Delete OIDC client ", + "description" : "Delete an openidconnect client", + "operationId" : "deleteClient", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + }, + "security" : [ { + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] + } ] + } + }, "/api/v1/clients/{inum}/scopes/{sinum}" : { "post" : { "summary" : "Add OIDC client scopes", @@ -749,18 +813,26 @@ } } }, - "/api/v1/clients/{inum}" : { + "/api/v1/clients/search" : { "get" : { - "summary" : "Get OIDC client", - "description" : "Get a specific OIDC client", - "operationId" : "getClientByInum", + "summary" : "Search OIDC clients", + "description" : "Search OIDC clients", + "operationId" : "searchClients", "parameters" : [ { - "name" : "inum", - "in" : "path", + "name" : "pattern", + "in" : "query", "required" : true, "schema" : { "type" : "string" } + }, { + "name" : "size", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 1 + } } ], "responses" : { "200" : { @@ -768,7 +840,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/OxAuthClient" + "type" : "string" } } } @@ -780,26 +852,20 @@ "security" : [ { "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] } ] - }, - "delete" : { - "summary" : "Delete OIDC client ", - "description" : "Delete an openidconnect client", - "operationId" : "deleteClient", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + } + }, + "/api/v1/configuration" : { + "get" : { + "summary" : "Get gluu configuration", + "description" : "Retrieve gluu configuration", + "operationId" : "getConfiguration", "responses" : { "200" : { - "description" : "Success", + "description" : "success", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/GluuConfiguration" } } } @@ -809,31 +875,15 @@ } }, "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] + "oauth2" : [ "https://gluu.org/auth/oxtrust.configuration.read" ] } ] } }, - "/api/v1/clients/search" : { + "/api/v1/configuration/scripts" : { "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 - } - } ], + "summary" : "Get all custom scripts", + "description" : "Get all custom scripts", + "operationId" : "listCustomScripts", "responses" : { "200" : { "description" : "Success", @@ -850,22 +900,29 @@ } }, "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] + "oauth2" : [ "https://gluu.org/auth/oxtrust.customscript.read" ] } ] - } - }, - "/api/v1/configuration" : { - "get" : { - "summary" : "Get gluu configuration", - "description" : "Retrieve gluu configuration", - "operationId" : "getConfiguration", + }, + "put" : { + "summary" : "Update custom script", + "description" : "Update custom script", + "operationId" : "updateCustomScript", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomScript" + } + } + } + }, "responses" : { "200" : { - "description" : "success", + "description" : "Success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuConfiguration" + "$ref" : "#/components/schemas/CustomScript" } } } @@ -873,10 +930,36 @@ "500" : { "description" : "Server error" } + } + }, + "post" : { + "summary" : "Add new custom script", + "description" : "Add new custom script", + "operationId" : "createCustomScript", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomScript" + } + } + } }, - "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.configuration.read" ] - } ] + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/CustomScript" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } } }, "/api/v1/configuration/scripts/{inum}" : { @@ -966,90 +1049,7 @@ } ] } }, - "/api/v1/configuration/scripts" : { - "get" : { - "summary" : "Get all custom scripts", - "description" : "Get all custom scripts", - "operationId" : "listCustomScripts", - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - }, - "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.customscript.read" ] - } ] - }, - "put" : { - "summary" : "Update custom script", - "description" : "Update custom script", - "operationId" : "updateCustomScript", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CustomScript" - } - } - } - }, - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CustomScript" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - }, - "post" : { - "summary" : "Add new custom script", - "description" : "Add new custom script", - "operationId" : "createCustomScript", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CustomScript" - } - } - } - }, - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/CustomScript" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/groups" : { + "/api/v1/groups" : { "get" : { "summary" : "Get groups", "description" : "Get groups", @@ -1138,11 +1138,11 @@ } } }, - "/api/v1/groups/{inum}/members" : { + "/api/v1/groups/{inum}" : { "get" : { - "summary" : "Get group members", - "description" : "Get a group members", - "operationId" : "getGroupMembers", + "summary" : "Get group by inum", + "description" : "Get a group by inum", + "operationId" : "getGroupByInum", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1157,7 +1157,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/GluuGroupApi" } } } @@ -1168,9 +1168,9 @@ } }, "delete" : { - "summary" : "Delete group member", - "description" : "Delete group member", - "operationId" : "deleteGroupMembers", + "summary" : "Delete group", + "description" : "Delete a group", + "operationId" : "deleteGroup", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1180,20 +1180,20 @@ } } ], "responses" : { - "default" : { - "description" : "default response", - "content" : { - "application/json" : { } - } + "200" : { + "description" : "Success" + }, + "500" : { + "description" : "Server error" } } } }, - "/api/v1/groups/{inum}" : { + "/api/v1/groups/{inum}/members" : { "get" : { - "summary" : "Get group by inum", - "description" : "Get a group by inum", - "operationId" : "getGroupByInum", + "summary" : "Get group members", + "description" : "Get a group members", + "operationId" : "getGroupMembers", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1208,7 +1208,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuGroupApi" + "type" : "string" } } } @@ -1219,9 +1219,9 @@ } }, "delete" : { - "summary" : "Delete group", - "description" : "Delete a group", - "operationId" : "deleteGroup", + "summary" : "Delete group member", + "description" : "Delete group member", + "operationId" : "deleteGroupMembers", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1230,9 +1230,47 @@ "type" : "string" } } ], + "responses" : { + "default" : { + "description" : "default response", + "content" : { + "application/json" : { } + } + } + } + } + }, + "/api/v1/groups/search" : { + "get" : { + "summary" : "Search groups", + "description" : "Search groups", + "operationId" : "searchGroups", + "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" + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } }, "500" : { "description" : "Server error" @@ -1305,44 +1343,6 @@ } } }, - "/api/v1/groups/search" : { - "get" : { - "summary" : "Search groups", - "description" : "Search groups", - "operationId" : "searchGroups", - "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" - } - } - } - }, "/configuration/idp" : { "get" : { "summary" : "Retrieve idp configuration", @@ -1394,33 +1394,6 @@ } } }, - "/api/v1/configuration/ldap/{name}" : { - "delete" : { - "summary" : "Delete an existing configuration", - "description" : "Delete an existing configuration", - "operationId" : "deleteLdapConfigurationByName", - "parameters" : [ { - "name" : "name", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - } - } - } - }, "/api/v1/configuration/ldap" : { "get" : { "summary" : "Get existing configuration", @@ -1495,20 +1468,19 @@ } } }, - "/api/v1/configuration/ldap/status" : { - "post" : { - "summary" : "Check status of a configuration", - "description" : "Check the status of a configuration", - "operationId" : "getLdapConfigurationStatus", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/LdapConnectionData" - } - } + "/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", + "required" : true, + "schema" : { + "type" : "string" } - }, + } ], "responses" : { "200" : { "description" : "Success", @@ -1523,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", @@ -1536,6 +1508,34 @@ "type" : "string" } } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + } + } + } + }, + "/api/v1/configuration/ldap/status" : { + "post" : { + "summary" : "Check status of a configuration", + "description" : "Check the status of a configuration", + "operationId" : "getLdapConfigurationStatus", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/LdapConnectionData" + } + } + } + }, "responses" : { "200" : { "description" : "Success", @@ -2160,6 +2160,36 @@ } } }, + "/api/v1/users/search" : { + "get" : { + "summary" : "Search person", + "description" : "Search person", + "operationId" : "searchPeople", + "parameters" : [ { + "name" : "pattern", + "in" : "query", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, "/api/v1/users" : { "get" : { "summary" : "Get people", @@ -2240,36 +2270,6 @@ } } }, - "/api/v1/users/search" : { - "get" : { - "summary" : "Search person", - "description" : "Search person", - "operationId" : "searchPeople", - "parameters" : [ { - "name" : "pattern", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - } - }, "/configuration/rpt" : { "get" : { "summary" : "Retrieve rpt configuration", @@ -2503,18 +2503,25 @@ } } }, - "/api/v1/scopes/{inum}/claims" : { + "/api/v1/scopes/search" : { "get" : { - "summary" : "Get scope claims", - "description" : "List all claims of a scope", - "operationId" : "getScopeClaims", + "summary" : "Search openid connect scopes", + "description" : "Search openid connect scopes", + "operationId" : "searchScope", "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" : { @@ -2533,25 +2540,18 @@ } } }, - "/api/v1/scopes/search" : { + "/api/v1/scopes/{inum}/claims" : { "get" : { - "summary" : "Search openid connect scopes", - "description" : "Search openid connect scopes", - "operationId" : "searchScope", + "summary" : "Get scope claims", + "description" : "List all claims of a scope", + "operationId" : "getScopeClaims", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "inum", + "in" : "path", + "required" : true, "schema" : { "type" : "string" } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 10 - } } ], "responses" : { "200" : { @@ -2650,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/search" : { "get" : { "summary" : "Search sector identifiers", @@ -2717,29 +2740,6 @@ } } }, - "/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/configuration/status" : { "get" : { "summary" : "Get server status", @@ -3034,9 +3034,9 @@ } } }, - "/api/v1/saml/tr/set_metadata/{inum}" : { + "/api/v1/saml/tr/add_attribute/{inum}" : { "post" : { - "operationId" : "setMetadata", + "operationId" : "addAttribute", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3047,12 +3047,7 @@ } ], "requestBody" : { "content" : { - "application/xml" : { - "schema" : { - "type" : "string" - } - }, - "text/plain" : { + "application/json" : { "schema" : { "type" : "string" } @@ -3070,9 +3065,31 @@ } } }, - "/api/v1/saml/tr/add_attribute/{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" : "addAttribute", + "operationId" : "setMetadata", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3083,7 +3100,12 @@ } ], "requestBody" : { "content" : { - "application/json" : { + "application/xml" : { + "schema" : { + "type" : "string" + } + }, + "text/plain" : { "schema" : { "type" : "string" } @@ -3101,36 +3123,54 @@ } } }, - "/api/v1/saml/tr/remove_attribute" : { - "delete" : { - "operationId" : "removeAttribute", + "/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" : { - "$ref" : "#/components/schemas/GluuAttribute" + "type" : "string" } } } }, "responses" : { - "default" : { - "description" : "default response", - "content" : { - "text/plain" : { } - } + "200" : { + "description" : "OK" + }, + "500" : { + "description" : "Server error" } } } }, - "/api/v1/saml/tr/generate_inum_for_new_trust_relationship" : { + "/api/v1/saml/tr/list_all_saml_trust_relationships" : { "get" : { - "operationId" : "generateInumForNewTrustRelationship", + "operationId" : "listAllSAMLTrustRelationships", + "parameters" : [ { + "name" : "size_limit", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], "responses" : { "200" : { "description" : "OK", "content" : { - "text/plain" : { + "application/json" : { "schema" : { "type" : "string" } @@ -3143,17 +3183,9 @@ } } }, - "/api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}" : { + "/api/v1/saml/tr/list_all_active_trust_relationships" : { "get" : { - "operationId" : "listDeconstructedTrustRelationships", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "operationId" : "listAllActiveTrustRelationships", "responses" : { "200" : { "description" : "OK", @@ -3171,9 +3203,9 @@ } } }, - "/api/v1/saml/tr/set_metadata_url/{inum}" : { - "post" : { - "operationId" : "setMetadataURL", + "/api/v1/saml/tr/list_all_other_federations/{inum}" : { + "get" : { + "operationId" : "listAllOtherFederations", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3182,19 +3214,16 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "text/plain" : { - "schema" : { - "type" : "string" - } - } - }, - "required" : true - }, "responses" : { "200" : { - "description" : "OK" + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } }, "500" : { "description" : "Server error" @@ -3202,22 +3231,29 @@ } } }, - "/api/v1/saml/tr/get_contacts/{inum}" : { + "/api/v1/saml/tr/search_trust_relationships" : { "get" : { - "operationId" : "getContacts", + "operationId" : "searchTrustRelationships", "parameters" : [ { - "name" : "inum", - "in" : "path", + "name" : "pattern", + "in" : "query", "required" : true, "schema" : { "type" : "string" } + }, { + "name" : "size_limit", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32" + } } ], "responses" : { "200" : { "description" : "OK", "content" : { - "text/plain" : { + "application/json" : { "schema" : { "type" : "string" } @@ -3230,28 +3266,11 @@ } } }, - "/api/v1/saml/tr/set_contacts/{inum}" : { - "post" : { - "summary" : "set contacts for TrustRelationship", - "description" : "Find TrustRelationship by inum and set contacts. Contacts parameter is List", - "operationId" : "setContacts", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, + "/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" @@ -3262,29 +3281,9 @@ } } }, - "/api/v1/saml/tr/list_all_federations" : { - "get" : { - "operationId" : "listAllFederations", - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/saml/tr/list_all_other_federations/{inum}" : { + "/api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}" : { "get" : { - "operationId" : "listAllOtherFederations", + "operationId" : "listDeconstructedTrustRelationships", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3310,22 +3309,14 @@ } } }, - "/api/v1/saml/tr/list_all_saml_trust_relationships" : { + "/api/v1/saml/tr/generate_inum_for_new_trust_relationship" : { "get" : { - "operationId" : "listAllSAMLTrustRelationships", - "parameters" : [ { - "name" : "size_limit", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32" - } - } ], + "operationId" : "generateInumForNewTrustRelationship", "responses" : { "200" : { "description" : "OK", "content" : { - "application/json" : { + "text/plain" : { "schema" : { "type" : "string" } @@ -3338,14 +3329,22 @@ } } }, - "/api/v1/saml/tr/list_all_active_trust_relationships" : { + "/api/v1/saml/tr/get_contacts/{inum}" : { "get" : { - "operationId" : "listAllActiveTrustRelationships", + "operationId" : "getContacts", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], "responses" : { "200" : { "description" : "OK", "content" : { - "application/json" : { + "text/plain" : { "schema" : { "type" : "string" } @@ -3358,49 +3357,31 @@ } } }, - "/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/search_trust_relationships" : { - "get" : { - "operationId" : "searchTrustRelationships", + "/api/v1/saml/tr/set_contacts/{inum}" : { + "post" : { + "summary" : "set contacts for TrustRelationship", + "description" : "Find TrustRelationship by inum and set contacts. Contacts parameter is List", + "operationId" : "setContacts", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "inum", + "in" : "path", "required" : true, "schema" : { "type" : "string" } - }, { - "name" : "size_limit", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32" - } } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "type" : "string" } } + } + }, + "responses" : { + "200" : { + "description" : "OK" }, "500" : { "description" : "Server error" @@ -3408,11 +3389,9 @@ } } }, - "/api/v1/saml/tr/set_certificate/{inum}" : { + "/api/v1/saml/tr/set_metadata_url/{inum}" : { "post" : { - "summary" : "set certificate for TrustRelationship", - "description" : "Find TrustRelationship by inum and set certificate.", - "operationId" : "setCertificate", + "operationId" : "setMetadataURL", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3428,7 +3407,8 @@ "type" : "string" } } - } + }, + "required" : true }, "responses" : { "200" : { @@ -3440,50 +3420,51 @@ } } }, - "/api/v1/inbound-saml/trusted-idp/{remoteIdpHost}" : { + "/api/v1/saml/tr/list_all_federations" : { "get" : { - "summary" : "Get TrustedIDP by remote idp host", - "description" : "Get a TrustedIDP by remote idp host", - "operationId" : "gluuTrustedIdpByRemoteIdpHost", - "parameters" : [ { - "name" : "remoteIdpHost", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" + "operationId" : "listAllFederations", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "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" : { - "$ref" : "#/components/schemas/TrustedIDPApi" + "type" : "string" } } } }, - "404" : { - "description" : "Resource not Found" - }, "500" : { "description" : "Server error" } } }, - "put" : { - "summary" : "Update TrustedIDP", - "description" : "Update a TrustedIDP", - "operationId" : "updateTrustedIdp", - "parameters" : [ { - "name" : "remoteIdpHost", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "post" : { + "summary" : "Add TrustedIDP", + "description" : "Add an TrustedIDP", + "operationId" : "createGluuTrustedIdp", "requestBody" : { "content" : { "application/json" : { @@ -3494,7 +3475,7 @@ } }, "responses" : { - "200" : { + "201" : { "description" : "Success", "content" : { "application/json" : { @@ -3504,18 +3485,20 @@ } } }, - "404" : { - "description" : "Resource not Found" + "403" : { + "description" : "Trust Relation already exists" }, "500" : { "description" : "Server error" } } - }, - "delete" : { - "summary" : "Delete TrustedIDP", - "description" : "Delete a TrustedIDP", - "operationId" : "deleteTrustedIdps", + } + }, + "/api/v1/inbound-saml/trusted-idp/{remoteIdpHost}" : { + "get" : { + "summary" : "Get TrustedIDP by remote idp host", + "description" : "Get a TrustedIDP by remote idp host", + "operationId" : "gluuTrustedIdpByRemoteIdpHost", "parameters" : [ { "name" : "remoteIdpHost", "in" : "path", @@ -3524,41 +3507,37 @@ "type" : "string" } } ], - "responses" : { - "200" : { - "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" + "$ref" : "#/components/schemas/TrustedIDPApi" } } } }, + "404" : { + "description" : "Resource not Found" + }, "500" : { "description" : "Server error" } - } - }, - "post" : { - "summary" : "Add TrustedIDP", - "description" : "Add an TrustedIDP", - "operationId" : "createGluuTrustedIdp", + } + }, + "put" : { + "summary" : "Update TrustedIDP", + "description" : "Update a TrustedIDP", + "operationId" : "updateTrustedIdp", + "parameters" : [ { + "name" : "remoteIdpHost", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], "requestBody" : { "content" : { "application/json" : { @@ -3569,7 +3548,7 @@ } }, "responses" : { - "201" : { + "200" : { "description" : "Success", "content" : { "application/json" : { @@ -3579,8 +3558,29 @@ } } }, - "403" : { - "description" : "Trust Relation already exists" + "404" : { + "description" : "Resource not Found" + }, + "500" : { + "description" : "Server error" + } + } + }, + "delete" : { + "summary" : "Delete TrustedIDP", + "description" : "Delete a TrustedIDP", + "operationId" : "deleteTrustedIdps", + "parameters" : [ { + "name" : "remoteIdpHost", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success" }, "500" : { "description" : "Server error" @@ -3621,34 +3621,11 @@ } } }, - "/api/v1/uma/resources/{id}/scopes" : { - "get" : { - "summary" : "Get UMA resource scopes", - "description" : "Get scopes of uma resource", - "operationId" : "getUmaResourceScopes", - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "description" : "default response", - "content" : { - "application/json" : { } - } - } - } - } - }, - "/api/v1/uma/resources/{id}/scopes/{inum}" : { + "/api/v1/uma/resources/{id}/clients/{inum}" : { "post" : { - "summary" : "Add UMA resource scope", - "description" : "add scope to uma resource", - "operationId" : "addScopeToUmaResource", + "summary" : "Add UMA resource client", + "description" : "add client to uma resource", + "operationId" : "addClientToUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3665,7 +3642,7 @@ } } ], "responses" : { - "200" : { + "201" : { "description" : "Success", "content" : { "application/json" : { @@ -3681,9 +3658,9 @@ } }, "delete" : { - "summary" : "Remove UMA resource scope", - "description" : "remove a scope from uma resource", - "operationId" : "removeScopeToUmaResource", + "summary" : "Remove UMA resource client", + "description" : "Remove client from uma resource", + "operationId" : "removeClientToUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3716,11 +3693,11 @@ } } }, - "/api/v1/uma/resources/{id}/clients/{inum}" : { + "/api/v1/uma/resources/{id}/scopes/{inum}" : { "post" : { - "summary" : "Add UMA resource client", - "description" : "add client to uma resource", - "operationId" : "addClientToUmaResource", + "summary" : "Add UMA resource scope", + "description" : "add scope to uma resource", + "operationId" : "addScopeToUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3737,7 +3714,7 @@ } } ], "responses" : { - "201" : { + "200" : { "description" : "Success", "content" : { "application/json" : { @@ -3753,9 +3730,9 @@ } }, "delete" : { - "summary" : "Remove UMA resource client", - "description" : "Remove client from uma resource", - "operationId" : "removeClientToUmaResource", + "summary" : "Remove UMA resource scope", + "description" : "remove a scope from uma resource", + "operationId" : "removeScopeToUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3811,6 +3788,29 @@ } } }, + "/api/v1/uma/resources/{id}/scopes" : { + "get" : { + "summary" : "Get UMA resource scopes", + "description" : "Get scopes of uma resource", + "operationId" : "getUmaResourceScopes", + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "description" : "default response", + "content" : { + "application/json" : { } + } + } + } + } + }, "/api/v1/uma/resources" : { "get" : { "summary" : "Get UMA resources", @@ -3891,6 +3891,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}" : { "get" : { "summary" : "Get UMA resource by id", @@ -3942,34 +3980,26 @@ } } }, - "/api/v1/uma/resources/search" : { + "/api/v1/uma/scopes/{inum}" : { "get" : { - "summary" : "Search UMA resources", - "description" : "Search uma resources", - "operationId" : "searchUmaResources", + "summary" : "Get UMA scope by inum", + "description" : "Get a uma scope by inum", + "operationId" : "getUmaScopeByInum", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "inum", + "in" : "path", "required" : true, "schema" : { "type" : "string" } - }, { - "name" : "size", - "in" : "query", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int32" - } } ], "responses" : { "200" : { - "description" : "Success", + "description" : "success", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/Scope" } } } @@ -3978,6 +4008,27 @@ "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" : { @@ -4090,57 +4141,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/radius/clients" : { "get" : { "summary" : "Get all radius clients", @@ -4514,25 +4514,25 @@ "gluuTooltip" : { "type" : "string" }, - "adminCanAccess" : { + "whitePagesCanView" : { "type" : "boolean" }, - "adminCanView" : { + "userCanAccess" : { "type" : "boolean" }, - "userCanEdit" : { + "adminCanAccess" : { "type" : "boolean" }, - "userCanAccess" : { + "adminCanView" : { "type" : "boolean" }, - "userCanView" : { + "userCanEdit" : { "type" : "boolean" }, "adminCanEdit" : { "type" : "boolean" }, - "whitePagesCanView" : { + "userCanView" : { "type" : "boolean" }, "baseDn" : { @@ -5758,13 +5758,13 @@ "internal" : { "type" : "boolean" }, - "locationPath" : { - "type" : "string" - }, "locationType" : { "type" : "string", "enum" : [ "ldap", "file" ] }, + "locationPath" : { + "type" : "string" + }, "baseDn" : { "type" : "string" } @@ -6651,109 +6651,6 @@ } } }, - "OxTrustBasicConfig" : { - "type" : "object", - "properties" : { - "baseDN" : { - "type" : "string" - }, - "orgSupportEmail" : { - "type" : "string" - }, - "applicationUrl" : { - "type" : "string" - }, - "baseEndpoint" : { - "type" : "string" - }, - "ldifStore" : { - "type" : "string" - }, - "updateStatus" : { - "type" : "boolean" - }, - "keystorePath" : { - "type" : "string" - }, - "allowPersonModification" : { - "type" : "boolean" - }, - "configGeneration" : { - "type" : "boolean" - }, - "gluuSpCert" : { - "type" : "string" - }, - "certDir" : { - "type" : "string" - }, - "servicesRestartTrigger" : { - "type" : "string" - }, - "loginRedirectUrl" : { - "type" : "string" - }, - "logoutRedirectUrl" : { - "type" : "string" - }, - "clientAssociationAttribute" : { - "type" : "string" - }, - "ignoreValidation" : { - "type" : "boolean" - }, - "umaIssuer" : { - "type" : "string" - }, - "cssLocation" : { - "type" : "string" - }, - "jsLocation" : { - "type" : "string" - }, - "enableUpdateNotification" : { - "type" : "boolean" - }, - "oxIncommonFlag" : { - "type" : "boolean" - }, - "clientWhiteList" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "clientBlackList" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "loggingLevel" : { - "type" : "string" - }, - "organizationName" : { - "type" : "string" - }, - "disableJdkLogger" : { - "type" : "boolean" - }, - "passwordResetRequestExpirationTime" : { - "type" : "integer", - "format" : "int32" - }, - "cleanServiceInterval" : { - "type" : "integer", - "format" : "int32" - }, - "enforceEmailUniqueness" : { - "type" : "boolean" - }, - "useLocalCache" : { - "type" : "boolean" - } - } - }, "AppConfiguration" : { "type" : "object", "properties" : { @@ -7119,6 +7016,109 @@ } } }, + "OxTrustBasicConfig" : { + "type" : "object", + "properties" : { + "baseDN" : { + "type" : "string" + }, + "orgSupportEmail" : { + "type" : "string" + }, + "applicationUrl" : { + "type" : "string" + }, + "baseEndpoint" : { + "type" : "string" + }, + "ldifStore" : { + "type" : "string" + }, + "updateStatus" : { + "type" : "boolean" + }, + "keystorePath" : { + "type" : "string" + }, + "allowPersonModification" : { + "type" : "boolean" + }, + "configGeneration" : { + "type" : "boolean" + }, + "gluuSpCert" : { + "type" : "string" + }, + "certDir" : { + "type" : "string" + }, + "servicesRestartTrigger" : { + "type" : "string" + }, + "loginRedirectUrl" : { + "type" : "string" + }, + "logoutRedirectUrl" : { + "type" : "string" + }, + "clientAssociationAttribute" : { + "type" : "string" + }, + "ignoreValidation" : { + "type" : "boolean" + }, + "umaIssuer" : { + "type" : "string" + }, + "cssLocation" : { + "type" : "string" + }, + "jsLocation" : { + "type" : "string" + }, + "enableUpdateNotification" : { + "type" : "boolean" + }, + "oxIncommonFlag" : { + "type" : "boolean" + }, + "clientWhiteList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "clientBlackList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "loggingLevel" : { + "type" : "string" + }, + "organizationName" : { + "type" : "string" + }, + "disableJdkLogger" : { + "type" : "boolean" + }, + "passwordResetRequestExpirationTime" : { + "type" : "integer", + "format" : "int32" + }, + "cleanServiceInterval" : { + "type" : "integer", + "format" : "int32" + }, + "enforceEmailUniqueness" : { + "type" : "boolean" + }, + "useLocalCache" : { + "type" : "boolean" + } + } + }, "OxTrustJsonSetting" : { "type" : "object", "properties" : { @@ -7538,10 +7538,16 @@ "displayValue" : { "type" : "object" }, + "new" : { + "type" : "boolean" + }, "booleanValue" : { "type" : "string", "enum" : [ "disabled", "enabled", "false", "true", "inactive", "active" ] }, + "userCanAccess" : { + "type" : "boolean" + }, "adminCanAccess" : { "type" : "boolean" }, @@ -7551,29 +7557,23 @@ "userCanEdit" : { "type" : "boolean" }, - "userCanAccess" : { + "adminCanEdit" : { "type" : "boolean" }, "userCanView" : { "type" : "boolean" }, - "adminCanEdit" : { + "multiValued" : { "type" : "boolean" }, - "stringValue" : { - "type" : "string" - }, "stringValues" : { "type" : "array", "items" : { "type" : "string" } }, - "multiValued" : { - "type" : "boolean" - }, - "new" : { - "type" : "boolean" + "stringValue" : { + "type" : "string" } } }, @@ -7711,6 +7711,15 @@ "certificate" : { "type" : "string" }, + "specificRelyingPartyConfig" : { + "type" : "boolean" + }, + "containerFederation" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + }, + "researchBundle" : { + "type" : "boolean" + }, "uniqueGluuEntityId" : { "uniqueItems" : true, "type" : "array", @@ -7719,21 +7728,12 @@ "type" : "string" } }, - "containerFederation" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" - }, - "specificRelyingPartyConfig" : { - "type" : "boolean" - }, "entityId" : { "type" : "string" }, "federation" : { "type" : "boolean" }, - "researchBundle" : { - "type" : "boolean" - }, "baseDn" : { "type" : "string" } diff --git a/api-server/src/main/resources/META-INF/openapi.yaml b/api-server/src/main/resources/META-INF/openapi.yaml index a421d0b39..d3ad4deae 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.5.0.sp1 paths: /configuration/api: get: @@ -116,6 +116,27 @@ paths: description: default response content: application/json: {} + /api/v1/attributes/{inum}: + delete: + summary: Delete gluu attribute + description: Deletes a gluu attribute + operationId: deleteAttribute + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: success + 404: + description: Not found + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.attribute.write /api/v1/attributes/search: get: summary: Search attributes @@ -145,27 +166,6 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.attribute.read - /api/v1/attributes/{inum}: - delete: - summary: Delete gluu attribute - description: Deletes a gluu attribute - operationId: deleteAttribute - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: success - 404: - description: Not found - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.attribute.write /api/v1/attributes/attribute/{inum}: get: summary: Get attribute by inum @@ -417,6 +417,51 @@ paths: description: default response content: application/json: {} + /api/v1/clients/{inum}: + get: + summary: Get OIDC client + description: Get a specific OIDC client + operationId: getClientByInum + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OxAuthClient' + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.client.read + delete: + summary: 'Delete OIDC client ' + description: Delete an openidconnect client + operationId: deleteClient + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.client.write /api/v1/clients/{inum}/scopes/{sinum}: post: summary: Add OIDC client scopes @@ -510,51 +555,6 @@ paths: description: default response content: application/json: {} - /api/v1/clients/{inum}: - get: - summary: Get OIDC client - description: Get a specific OIDC client - operationId: getClientByInum - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/OxAuthClient' - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.client.read - delete: - summary: 'Delete OIDC client ' - description: Delete an openidconnect client - operationId: deleteClient - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.client.write /api/v1/clients/search: get: summary: Search OIDC clients @@ -601,6 +601,59 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.configuration.read + /api/v1/configuration/scripts: + get: + summary: Get all custom scripts + description: Get all custom scripts + operationId: listCustomScripts + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.customscript.read + put: + summary: Update custom script + description: Update custom script + operationId: updateCustomScript + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomScript' + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CustomScript' + 500: + description: Server error + post: + summary: Add new custom script + description: Add new custom script + operationId: createCustomScript + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/CustomScript' + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/CustomScript' + 500: + description: Server error /api/v1/configuration/scripts/{inum}: get: summary: Get scripts by inum @@ -662,59 +715,6 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.customscript.read - /api/v1/configuration/scripts: - get: - summary: Get all custom scripts - description: Get all custom scripts - operationId: listCustomScripts - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.customscript.read - put: - summary: Update custom script - description: Update custom script - operationId: updateCustomScript - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomScript' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CustomScript' - 500: - description: Server error - post: - summary: Add new custom script - description: Add new custom script - operationId: createCustomScript - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/CustomScript' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/CustomScript' - 500: - description: Server error /api/v1/groups: get: summary: Get groups @@ -772,11 +772,11 @@ paths: $ref: '#/components/schemas/GluuGroupApi' 500: description: Server error - /api/v1/groups/{inum}/members: + /api/v1/groups/{inum}: get: - summary: Get group members - description: Get a group members - operationId: getGroupMembers + summary: Get group by inum + description: Get a group by inum + operationId: getGroupByInum parameters: - name: inum in: path @@ -789,13 +789,13 @@ paths: content: application/json: schema: - type: string + $ref: '#/components/schemas/GluuGroupApi' 500: description: Server error delete: - summary: Delete group member - description: Delete group member - operationId: deleteGroupMembers + summary: Delete group + description: Delete a group + operationId: deleteGroup parameters: - name: inum in: path @@ -803,15 +803,15 @@ paths: schema: type: string responses: - default: - description: default response - content: - application/json: {} - /api/v1/groups/{inum}: + 200: + description: Success + 500: + description: Server error + /api/v1/groups/{inum}/members: get: - summary: Get group by inum - description: Get a group by inum - operationId: getGroupByInum + summary: Get group members + description: Get a group members + operationId: getGroupMembers parameters: - name: inum in: path @@ -824,22 +824,48 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/GluuGroupApi' + type: string 500: description: Server error delete: - summary: Delete group - description: Delete a group - operationId: deleteGroup + summary: Delete group member + description: Delete group member + operationId: deleteGroupMembers parameters: - name: inum in: path required: true schema: type: string + responses: + default: + description: default response + content: + application/json: {} + /api/v1/groups/search: + get: + summary: Search groups + description: Search groups + operationId: searchGroups + 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 /api/v1/groups/{inum}/members/{minum}: @@ -887,32 +913,6 @@ paths: description: Success 500: description: Server error - /api/v1/groups/search: - get: - summary: Search groups - description: Search groups - operationId: searchGroups - 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 /configuration/idp: get: summary: Retrieve idp configuration @@ -945,24 +945,6 @@ paths: $ref: '#/components/schemas/IdpConfig' 500: description: Server error - /api/v1/configuration/ldap/{name}: - delete: - summary: Delete an existing configuration - description: Delete an existing configuration - operationId: deleteLdapConfigurationByName - parameters: - - name: name - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - type: string /api/v1/configuration/ldap: get: summary: Get existing configuration @@ -1009,16 +991,17 @@ paths: application/json: schema: $ref: '#/components/schemas/LdapConfigurationDTO' - /api/v1/configuration/ldap/status: - post: - summary: Check status of a configuration - description: Check the status of a configuration - operationId: getLdapConfigurationStatus - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/LdapConnectionData' + /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 + required: true + schema: + type: string responses: 200: description: Success @@ -1026,17 +1009,34 @@ paths: application/json: schema: $ref: '#/components/schemas/ConnectionStatusDTO' - /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 required: true schema: type: string + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + /api/v1/configuration/ldap/status: + post: + summary: Check status of a configuration + description: Check the status of a configuration + operationId: getLdapConfigurationStatus + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/LdapConnectionData' responses: 200: description: Success @@ -1433,6 +1433,26 @@ paths: description: Success 500: description: Server error + /api/v1/users/search: + get: + summary: Search person + description: Search person + operationId: searchPeople + parameters: + - name: pattern + in: query + required: true + schema: + type: string + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error /api/v1/users: get: summary: Get people @@ -1483,26 +1503,6 @@ paths: $ref: '#/components/schemas/GluuPersonApi' 500: description: Server error - /api/v1/users/search: - get: - summary: Search person - description: Search person - operationId: searchPeople - parameters: - - name: pattern - in: query - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error /configuration/rpt: get: summary: Retrieve rpt configuration @@ -1652,17 +1652,22 @@ paths: description: Success 500: description: Server error - /api/v1/scopes/{inum}/claims: + /api/v1/scopes/search: get: - summary: Get scope claims - description: List all claims of a scope - operationId: getScopeClaims + summary: Search openid connect scopes + description: Search openid connect scopes + operationId: searchScope 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 @@ -1672,22 +1677,17 @@ paths: type: string 500: description: Server error - /api/v1/scopes/search: + /api/v1/scopes/{inum}/claims: get: - summary: Search openid connect scopes - description: Search openid connect scopes - operationId: searchScope + summary: Get scope claims + description: List all claims of a scope + operationId: getScopeClaims parameters: - - name: pattern - in: query + - name: inum + in: path + required: true schema: type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 10 responses: 200: description: Success @@ -1747,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/search: get: summary: Search sector identifiers @@ -1792,22 +1808,6 @@ 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/configuration/status: get: summary: Get server status @@ -1996,9 +1996,9 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/set_metadata/{inum}: + /api/v1/saml/tr/add_attribute/{inum}: post: - operationId: setMetadata + operationId: addAttribute parameters: - name: inum in: path @@ -2007,30 +2007,7 @@ paths: type: string requestBody: content: - application/xml: - schema: - type: string - text/plain: - schema: - type: string - required: true - responses: - 200: - description: OK - 500: - description: Server error - /api/v1/saml/tr/add_attribute/{inum}: - post: - operationId: addAttribute - parameters: - - name: inum - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: + application/json: schema: type: string required: true @@ -2052,39 +2029,34 @@ paths: description: default response content: text/plain: {} - /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_deconstructed_trust_relationships/{inum}: - get: - operationId: listDeconstructedTrustRelationships + /api/v1/saml/tr/set_metadata/{inum}: + post: + operationId: setMetadata parameters: - name: inum in: path required: true schema: type: string + requestBody: + content: + application/xml: + schema: + type: string + 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/set_metadata_url/{inum}: + /api/v1/saml/tr/set_certificate/{inum}: post: - operationId: setMetadataURL + summary: set certificate for TrustRelationship + description: Find TrustRelationship by inum and set certificate. + operationId: setCertificate parameters: - name: inum in: path @@ -2096,55 +2068,32 @@ paths: text/plain: schema: type: string - required: true responses: 200: description: OK 500: description: Server error - /api/v1/saml/tr/get_contacts/{inum}: + /api/v1/saml/tr/list_all_saml_trust_relationships: get: - operationId: getContacts + operationId: listAllSAMLTrustRelationships parameters: - - name: inum - in: path - required: true + - name: size_limit + in: query schema: - type: string + type: integer + format: int32 responses: 200: description: OK content: - text/plain: + application/json: schema: type: string 500: description: Server error - /api/v1/saml/tr/set_contacts/{inum}: - post: - summary: set contacts for TrustRelationship - description: Find TrustRelationship by inum and set contacts. Contacts parameter - is List - operationId: setContacts - parameters: - - name: inum - in: path - required: true - schema: - type: string - requestBody: - content: - application/json: - schema: - type: string - responses: - 200: - description: OK - 500: - description: Server error - /api/v1/saml/tr/list_all_federations: + /api/v1/saml/tr/list_all_active_trust_relationships: get: - operationId: listAllFederations + operationId: listAllActiveTrustRelationships responses: 200: description: OK @@ -2172,10 +2121,15 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/list_all_saml_trust_relationships: + /api/v1/saml/tr/search_trust_relationships: get: - operationId: listAllSAMLTrustRelationships + operationId: searchTrustRelationships parameters: + - name: pattern + in: query + required: true + schema: + type: string - name: size_limit in: query schema: @@ -2190,9 +2144,25 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/list_all_active_trust_relationships: + /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_deconstructed_trust_relationships/{inum}: get: - operationId: listAllActiveTrustRelationships + operationId: listDeconstructedTrustRelationships + parameters: + - name: inum + in: path + required: true + schema: + type: string responses: 200: description: OK @@ -2202,44 +2172,61 @@ 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/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/search_trust_relationships: + /api/v1/saml/tr/get_contacts/{inum}: get: - operationId: searchTrustRelationships + operationId: getContacts parameters: - - name: pattern - in: query + - name: inum + in: path required: true schema: type: string - - name: size_limit - in: query - schema: - type: integer - format: int32 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/set_contacts/{inum}: post: - summary: set certificate for TrustRelationship - description: Find TrustRelationship by inum and set certificate. - operationId: setCertificate + summary: set contacts for TrustRelationship + description: Find TrustRelationship by inum and set contacts. Contacts parameter + is List + operationId: setContacts + parameters: + - name: inum + in: path + required: true + schema: + type: string + requestBody: + content: + application/json: + schema: + type: string + responses: + 200: + description: OK + 500: + description: Server error + /api/v1/saml/tr/set_metadata_url/{inum}: + post: + operationId: setMetadataURL parameters: - name: inum in: path @@ -2251,11 +2238,58 @@ paths: text/plain: schema: type: string + required: true responses: 200: description: OK 500: description: Server error + /api/v1/saml/tr/list_all_federations: + get: + operationId: listAllFederations + responses: + 200: + description: OK + content: + application/json: + schema: + type: string + 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/inbound-saml/trusted-idp/{remoteIdpHost}: get: summary: Get TrustedIDP by remote idp host @@ -2319,40 +2353,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/inbound-saml/trusted-idp/inum/{inum}: get: summary: Get TrustedIDP by inum @@ -2375,27 +2375,11 @@ paths: description: Resource not Found 500: description: Server error - /api/v1/uma/resources/{id}/scopes: - get: - summary: Get UMA resource scopes - description: Get scopes of uma resource - operationId: getUmaResourceScopes - parameters: - - name: id - in: path - required: true - schema: - type: string - responses: - default: - description: default response - content: - application/json: {} - /api/v1/uma/resources/{id}/scopes/{inum}: + /api/v1/uma/resources/{id}/clients/{inum}: post: - summary: Add UMA resource scope - description: add scope to uma resource - operationId: addScopeToUmaResource + summary: Add UMA resource client + description: add client to uma resource + operationId: addClientToUmaResource parameters: - name: id in: path @@ -2408,7 +2392,7 @@ paths: schema: type: string responses: - 200: + 201: description: Success content: application/json: @@ -2417,9 +2401,9 @@ paths: 500: description: Server error delete: - summary: Remove UMA resource scope - description: remove a scope from uma resource - operationId: removeScopeToUmaResource + summary: Remove UMA resource client + description: Remove client from uma resource + operationId: removeClientToUmaResource parameters: - name: id in: path @@ -2440,11 +2424,11 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error - /api/v1/uma/resources/{id}/clients/{inum}: + /api/v1/uma/resources/{id}/scopes/{inum}: post: - summary: Add UMA resource client - description: add client to uma resource - operationId: addClientToUmaResource + summary: Add UMA resource scope + description: add scope to uma resource + operationId: addScopeToUmaResource parameters: - name: id in: path @@ -2457,7 +2441,7 @@ paths: schema: type: string responses: - 201: + 200: description: Success content: application/json: @@ -2466,9 +2450,9 @@ paths: 500: description: Server error delete: - summary: Remove UMA resource client - description: Remove client from uma resource - operationId: removeClientToUmaResource + summary: Remove UMA resource scope + description: remove a scope from uma resource + operationId: removeScopeToUmaResource parameters: - name: id in: path @@ -2505,6 +2489,22 @@ paths: description: default response content: application/json: {} + /api/v1/uma/resources/{id}/scopes: + get: + summary: Get UMA resource scopes + description: Get scopes of uma resource + operationId: getUmaResourceScopes + parameters: + - name: id + in: path + required: true + schema: + type: string + responses: + default: + description: default response + content: + application/json: {} /api/v1/uma/resources: get: summary: Get UMA resources @@ -2552,7 +2552,33 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/UmaResource' + $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 + responses: + 200: + description: Success + content: + application/json: + schema: + type: string 500: description: Server error /api/v1/uma/resources/{id}: @@ -2590,30 +2616,39 @@ paths: description: Success 500: description: Server error - /api/v1/uma/resources/search: + /api/v1/uma/scopes/{inum}: get: - summary: Search UMA resources - description: Search uma resources - operationId: searchUmaResources + summary: Get UMA scope by inum + description: Get a uma scope by inum + operationId: getUmaScopeByInum parameters: - - name: pattern - in: query + - name: inum + in: path required: true schema: type: string - - name: size - in: query - required: true - schema: - type: integer - format: int32 responses: 200: - description: Success + description: success content: application/json: schema: - type: string + $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: @@ -2686,41 +2721,6 @@ paths: type: string 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/radius/clients: get: summary: Get all radius clients @@ -2998,19 +2998,19 @@ components: $ref: '#/components/schemas/AttributeValidation' gluuTooltip: type: string + whitePagesCanView: + type: boolean + userCanAccess: + type: boolean adminCanAccess: type: boolean adminCanView: type: boolean userCanEdit: type: boolean - userCanAccess: - type: boolean - userCanView: - type: boolean adminCanEdit: type: boolean - whitePagesCanView: + userCanView: type: boolean baseDn: type: string @@ -4025,13 +4025,13 @@ components: type: boolean internal: type: boolean - locationPath: - type: string locationType: type: string enum: - ldap - file + locationPath: + type: string baseDn: type: string ScriptError: @@ -4636,75 +4636,6 @@ components: type: string cookieDomain: type: string - OxTrustBasicConfig: - type: object - properties: - baseDN: - type: string - orgSupportEmail: - type: string - applicationUrl: - type: string - baseEndpoint: - type: string - ldifStore: - type: string - updateStatus: - type: boolean - keystorePath: - type: string - allowPersonModification: - type: boolean - configGeneration: - type: boolean - gluuSpCert: - type: string - certDir: - type: string - servicesRestartTrigger: - type: string - loginRedirectUrl: - type: string - logoutRedirectUrl: - type: string - clientAssociationAttribute: - type: string - ignoreValidation: - type: boolean - umaIssuer: - type: string - cssLocation: - type: string - jsLocation: - type: string - enableUpdateNotification: - type: boolean - oxIncommonFlag: - type: boolean - clientWhiteList: - type: array - items: - type: string - clientBlackList: - type: array - items: - type: string - loggingLevel: - type: string - organizationName: - type: string - disableJdkLogger: - type: boolean - passwordResetRequestExpirationTime: - type: integer - format: int32 - cleanServiceInterval: - type: integer - format: int32 - enforceEmailUniqueness: - type: boolean - useLocalCache: - type: boolean AppConfiguration: type: object properties: @@ -4959,6 +4890,75 @@ components: - BYPASS userExtensionSchemaURI: type: string + OxTrustBasicConfig: + type: object + properties: + baseDN: + type: string + orgSupportEmail: + type: string + applicationUrl: + type: string + baseEndpoint: + type: string + ldifStore: + type: string + updateStatus: + type: boolean + keystorePath: + type: string + allowPersonModification: + type: boolean + configGeneration: + type: boolean + gluuSpCert: + type: string + certDir: + type: string + servicesRestartTrigger: + type: string + loginRedirectUrl: + type: string + logoutRedirectUrl: + type: string + clientAssociationAttribute: + type: string + ignoreValidation: + type: boolean + umaIssuer: + type: string + cssLocation: + type: string + jsLocation: + type: string + enableUpdateNotification: + type: boolean + oxIncommonFlag: + type: boolean + clientWhiteList: + type: array + items: + type: string + clientBlackList: + type: array + items: + type: string + loggingLevel: + type: string + organizationName: + type: string + disableJdkLogger: + type: boolean + passwordResetRequestExpirationTime: + type: integer + format: int32 + cleanServiceInterval: + type: integer + format: int32 + enforceEmailUniqueness: + type: boolean + useLocalCache: + type: boolean OxTrustJsonSetting: type: object properties: @@ -5250,6 +5250,8 @@ components: - active displayValue: type: object + new: + type: boolean booleanValue: type: string enum: @@ -5259,28 +5261,26 @@ components: - "true" - inactive - active + userCanAccess: + type: boolean adminCanAccess: type: boolean adminCanView: type: boolean userCanEdit: type: boolean - userCanAccess: + adminCanEdit: type: boolean userCanView: type: boolean - adminCanEdit: + multiValued: type: boolean - stringValue: - type: string stringValues: type: array items: type: string - multiValued: - type: boolean - new: - type: boolean + stringValue: + type: string GluuSAMLTrustRelationship: required: - description @@ -5393,22 +5393,22 @@ components: type: string certificate: type: string + specificRelyingPartyConfig: + type: boolean + containerFederation: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' + researchBundle: + type: boolean uniqueGluuEntityId: uniqueItems: true type: array writeOnly: true items: type: string - containerFederation: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' - specificRelyingPartyConfig: - type: boolean entityId: type: string federation: type: boolean - researchBundle: - type: boolean baseDn: type: string writeOnly: true