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..f227f6565 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.1.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 8e2d43a4d..315a1e5eb 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.1.sp1" }, "paths" : { "/configuration/api" : { @@ -173,26 +173,18 @@ } } }, - "/api/v1/attributes/search" : { + "/api/v1/attributes/attribute/{inum}" : { "get" : { - "summary" : "Search attributes", - "description" : "Perform an attribute search", - "operationId" : "searchAttributes", + "summary" : "Get attribute by inum", + "description" : "Get an attribute by inum", + "operationId" : "getAttributeByInum", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "inum", + "in" : "path", "required" : true, "schema" : { "type" : "string" } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 1 - } } ], "responses" : { "200" : { @@ -214,18 +206,26 @@ } ] } }, - "/api/v1/attributes/attribute/{inum}" : { + "/api/v1/attributes/search" : { "get" : { - "summary" : "Get attribute by inum", - "description" : "Get an attribute by inum", - "operationId" : "getAttributeByInum", + "summary" : "Search attributes", + "description" : "Perform an attribute search", + "operationId" : "searchAttributes", "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" : { @@ -671,11 +671,11 @@ } } }, - "/api/v1/clients/{inum}" : { - "get" : { - "summary" : "Get OIDC client", - "description" : "Get a specific OIDC client", - "operationId" : "getClientByInum", + "/api/v1/clients/{inum}/scopes/{sinum}" : { + "post" : { + "summary" : "Add OIDC client scopes", + "description" : "Add scopes to OIDC client", + "operationId" : "addScopeToClient", "parameters" : [ { "name" : "inum", "in" : "path", @@ -683,6 +683,13 @@ "schema" : { "type" : "string" } + }, { + "name" : "sinum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -690,7 +697,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/OxAuthClient" + "type" : "string" } } } @@ -700,13 +707,13 @@ } }, "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] } ] }, "delete" : { - "summary" : "Delete OIDC client ", - "description" : "Delete an openidconnect client", - "operationId" : "deleteClient", + "summary" : "Remove OIDC client scope", + "description" : "Remove an existing scope from client", + "operationId" : "removeScopeToClient", "parameters" : [ { "name" : "inum", "in" : "path", @@ -714,6 +721,13 @@ "schema" : { "type" : "string" } + }, { + "name" : "sinum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -735,26 +749,18 @@ } ] } }, - "/api/v1/clients/search" : { + "/api/v1/clients/{inum}" : { "get" : { - "summary" : "Search OIDC clients", - "description" : "Search OIDC clients", - "operationId" : "searchClients", + "summary" : "Get OIDC client", + "description" : "Get a specific OIDC client", + "operationId" : "getClientByInum", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "inum", + "in" : "path", "required" : true, "schema" : { "type" : "string" } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 1 - } } ], "responses" : { "200" : { @@ -762,7 +768,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/OxAuthClient" } } } @@ -774,13 +780,11 @@ "security" : [ { "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] } ] - } - }, - "/api/v1/clients/{inum}/scopes/{sinum}" : { - "post" : { - "summary" : "Add OIDC client scopes", - "description" : "Add scopes to OIDC client", - "operationId" : "addScopeToClient", + }, + "delete" : { + "summary" : "Delete OIDC client ", + "description" : "Delete an openidconnect client", + "operationId" : "deleteClient", "parameters" : [ { "name" : "inum", "in" : "path", @@ -788,13 +792,6 @@ "schema" : { "type" : "string" } - }, { - "name" : "sinum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { @@ -814,24 +811,27 @@ "security" : [ { "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] } ] - }, - "delete" : { - "summary" : "Remove OIDC client scope", - "description" : "Remove an existing scope from client", - "operationId" : "removeScopeToClient", + } + }, + "/api/v1/clients/search" : { + "get" : { + "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" : "sinum", - "in" : "path", - "required" : true, + "name" : "size", + "in" : "query", "schema" : { - "type" : "string" + "type" : "integer", + "format" : "int32", + "default" : 1 } } ], "responses" : { @@ -850,7 +850,7 @@ } }, "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] } ] } }, @@ -1138,6 +1138,95 @@ } } }, + "/api/v1/groups/{inum}" : { + "get" : { + "summary" : "Get group by inum", + "description" : "Get a group by inum", + "operationId" : "getGroupByInum", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuGroupApi" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + }, + "delete" : { + "summary" : "Delete group", + "description" : "Delete a group", + "operationId" : "deleteGroup", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "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" + } + } + } + }, "/api/v1/groups/{inum}/members/{minum}" : { "post" : { "summary" : "Add group member", @@ -1254,107 +1343,18 @@ } } }, - "/api/v1/groups/{inum}" : { + "/configuration/idp" : { "get" : { - "summary" : "Get group by inum", - "description" : "Get a group by inum", - "operationId" : "getGroupByInum", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "summary" : "Retrieve idp configuration", + "description" : "Retrieve idp configuration", + "operationId" : "retrieveIdpConfiguration", "responses" : { "200" : { - "description" : "Success", + "description" : "success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuGroupApi" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - }, - "delete" : { - "summary" : "Delete group", - "description" : "Delete a group", - "operationId" : "deleteGroup", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "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", - "description" : "Retrieve idp configuration", - "operationId" : "retrieveIdpConfiguration", - "responses" : { - "200" : { - "description" : "success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/IdpConfig" + "$ref" : "#/components/schemas/IdpConfig" } } } @@ -1468,27 +1468,26 @@ } } }, - "/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}" : { + "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" : { - "$ref" : "#/components/schemas/ConnectionStatusDTO" + "type" : "string" } } } @@ -1496,26 +1495,27 @@ } } }, - "/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" + "/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", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/ConnectionStatusDTO" } } } @@ -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" : { @@ -2607,48 +2607,18 @@ } } }, - "/api/v1/sectoridentifiers/sector/{id}" : { + "/api/v1/sectoridentifiers" : { "get" : { - "summary" : "Get sector identifier", - "description" : "Get a sector identifier", - "operationId" : "getSectorIdentifierById", - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "summary" : "Get all sector identifiers", + "description" : "Get all sectors identifiers", + "operationId" : "getAllSectorIdentifiers", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/OxAuthSectorIdentifier" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/sectoridentifiers" : { - "get" : { - "summary" : "Get all sector identifiers", - "description" : "Get all sectors identifiers", - "operationId" : "getAllSectorIdentifiers", - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" + "type" : "string" } } } @@ -2717,6 +2687,36 @@ } } }, + "/api/v1/sectoridentifiers/sector/{id}" : { + "get" : { + "summary" : "Get sector identifier", + "description" : "Get a sector identifier", + "operationId" : "getSectorIdentifierById", + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/OxAuthSectorIdentifier" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, "/api/v1/sectoridentifiers/{inum}" : { "delete" : { "summary" : "Delete sector identifier", @@ -3065,28 +3065,6 @@ } } }, - "/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" : "setMetadata", @@ -3123,61 +3101,33 @@ } } }, - "/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" - } - } ], + "/api/v1/saml/tr/remove_attribute" : { + "delete" : { + "operationId" : "removeAttribute", "requestBody" : { "content" : { "text/plain" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/GluuAttribute" } } } }, "responses" : { - "200" : { - "description" : "OK" - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/saml/tr/list_all_active_trust_relationships" : { - "get" : { - "operationId" : "listAllActiveTrustRelationships", - "responses" : { - "200" : { - "description" : "OK", + "default" : { + "description" : "default response", "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } + "text/plain" : { } } - }, - "500" : { - "description" : "Server error" } } } }, - "/api/v1/saml/tr/list_all_other_federations/{inum}" : { - "get" : { - "operationId" : "listAllOtherFederations", + "/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", @@ -3186,28 +3136,15 @@ "type" : "string" } } ], - "responses" : { - "200" : { - "description" : "OK", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "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", + }, "responses" : { "200" : { "description" : "OK" @@ -3218,57 +3155,22 @@ } } }, - "/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", - "content" : { - "application/json" : { - "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" } @@ -3281,22 +3183,14 @@ } } }, - "/api/v1/saml/tr/get_contacts/{inum}" : { + "/api/v1/saml/tr/list_all_federations" : { "get" : { - "operationId" : "getContacts", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "operationId" : "listAllFederations", "responses" : { "200" : { "description" : "OK", "content" : { - "text/plain" : { + "application/json" : { "schema" : { "type" : "string" } @@ -3340,11 +3234,11 @@ } } }, - "/api/v1/saml/tr/set_contacts/{inum}" : { + "/api/v1/saml/tr/set_certificate/{inum}" : { "post" : { - "summary" : "set contacts for TrustRelationship", - "description" : "Find TrustRelationship by inum and set contacts. Contacts parameter is List", - "operationId" : "setContacts", + "summary" : "set certificate for TrustRelationship", + "description" : "Find TrustRelationship by inum and set certificate.", + "operationId" : "setCertificate", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3355,7 +3249,7 @@ } ], "requestBody" : { "content" : { - "application/json" : { + "text/plain" : { "schema" : { "type" : "string" } @@ -3372,9 +3266,17 @@ } } }, - "/api/v1/saml/tr/list_all_federations" : { + "/api/v1/saml/tr/list_all_saml_trust_relationships" : { "get" : { - "operationId" : "listAllFederations", + "operationId" : "listAllSAMLTrustRelationships", + "parameters" : [ { + "name" : "size_limit", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32" + } + } ], "responses" : { "200" : { "description" : "OK", @@ -3392,9 +3294,9 @@ } } }, - "/api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}" : { + "/api/v1/saml/tr/list_all_other_federations/{inum}" : { "get" : { - "operationId" : "listDeconstructedTrustRelationships", + "operationId" : "listAllOtherFederations", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3420,19 +3322,14 @@ } } }, - "/api/v1/saml/tr/generate_inum_for_new_trust_relationship" : { - "get" : { - "operationId" : "generateInumForNewTrustRelationship", + "/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", - "content" : { - "text/plain" : { - "schema" : { - "type" : "string" - } - } - } + "description" : "OK" }, "500" : { "description" : "Server error" @@ -3440,14 +3337,12 @@ } } }, - "/api/v1/inbound-saml/trusted-idp" : { + "/api/v1/saml/tr/list_all_active_trust_relationships" : { "get" : { - "summary" : "Retrieve all trusted-idps", - "description" : "Retrieve all trusted-idps", - "operationId" : "gluuTrustedIdps", + "operationId" : "listAllActiveTrustRelationships", "responses" : { "200" : { - "description" : "Success", + "description" : "OK", "content" : { "application/json" : { "schema" : { @@ -3460,7 +3355,112 @@ "description" : "Server error" } } - }, + } + }, + "/api/v1/saml/tr/search_trust_relationships" : { + "get" : { + "operationId" : "searchTrustRelationships", + "parameters" : [ { + "name" : "pattern", + "in" : "query", + "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" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/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", + "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/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", @@ -3621,129 +3621,11 @@ } } }, - "/api/v1/uma/resources/{id}/clients/{inum}" : { - "post" : { - "summary" : "Add UMA resource client", - "description" : "add client to uma resource", - "operationId" : "addClientToUmaResource", - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "201" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UmaResource" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - }, - "delete" : { - "summary" : "Remove UMA resource client", - "description" : "Remove client from uma resource", - "operationId" : "removeClientToUmaResource", - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UmaResource" - } - } - } - }, - "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}/clients" : { + "/api/v1/uma/resources/{id}" : { "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/{inum}" : { - "post" : { - "summary" : "Add UMA resource scope", - "description" : "add scope to uma resource", - "operationId" : "addScopeToUmaResource", + "summary" : "Get UMA resource by id", + "description" : "Get a uma resource by id", + "operationId" : "getUmaResourceById", "parameters" : [ { "name" : "id", "in" : "path", @@ -3751,13 +3633,6 @@ "schema" : { "type" : "string" } - }, { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { @@ -3776,9 +3651,9 @@ } }, "delete" : { - "summary" : "Remove UMA resource scope", - "description" : "remove a scope from uma resource", - "operationId" : "removeScopeToUmaResource", + "summary" : "Delete UMA resource", + "description" : "Delete a uma resource", + "operationId" : "deleteUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3786,24 +3661,10 @@ "schema" : { "type" : "string" } - }, { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UmaResource" - } - } - } + "description" : "Success" }, "500" : { "description" : "Server error" @@ -3911,7 +3772,79 @@ } } } - }, + }, + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UmaResource" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/uma/resources/{id}/scopes/{inum}" : { + "post" : { + "summary" : "Add UMA resource scope", + "description" : "add scope to uma resource", + "operationId" : "addScopeToUmaResource", + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UmaResource" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + }, + "delete" : { + "summary" : "Remove UMA resource scope", + "description" : "remove a scope from uma resource", + "operationId" : "removeScopeToUmaResource", + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], "responses" : { "200" : { "description" : "Success", @@ -3929,11 +3862,11 @@ } } }, - "/api/v1/uma/resources/{id}" : { + "/api/v1/uma/resources/{id}/clients" : { "get" : { - "summary" : "Get UMA resource by id", - "description" : "Get a uma resource by id", - "operationId" : "getUmaResourceById", + "summary" : "Get clients of UMA resources", + "description" : "Get clients of uma resource", + "operationId" : "getUmaResourceClients", "parameters" : [ { "name" : "id", "in" : "path", @@ -3943,7 +3876,37 @@ } } ], "responses" : { - "200" : { + "default" : { + "description" : "default response", + "content" : { + "application/json" : { } + } + } + } + } + }, + "/api/v1/uma/resources/{id}/clients/{inum}" : { + "post" : { + "summary" : "Add UMA resource client", + "description" : "add client to uma resource", + "operationId" : "addClientToUmaResource", + "parameters" : [ { + "name" : "id", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + }, { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "201" : { "description" : "Success", "content" : { "application/json" : { @@ -3959,9 +3922,9 @@ } }, "delete" : { - "summary" : "Delete UMA resource", - "description" : "Delete a uma resource", - "operationId" : "deleteUmaResource", + "summary" : "Remove UMA resource client", + "description" : "Remove client from uma resource", + "operationId" : "removeClientToUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3969,10 +3932,24 @@ "schema" : { "type" : "string" } + }, { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { - "description" : "Success" + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UmaResource" + } + } + } }, "500" : { "description" : "Server error" @@ -3980,32 +3957,25 @@ } } }, - "/api/v1/uma/scopes/search" : { + "/api/v1/uma/resources/{id}/scopes" : { "get" : { - "summary" : "Search UMA scopes", - "description" : "Search uma scopes", - "operationId" : "searchUmaScopes", + "summary" : "Get UMA resource scopes", + "description" : "Get scopes of uma resource", + "operationId" : "getUmaResourceScopes", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "id", + "in" : "path", "required" : true, "schema" : { "type" : "string" } } ], "responses" : { - "200" : { - "description" : "success", + "default" : { + "description" : "default response", "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } + "application/json" : { } } - }, - "500" : { - "description" : "Server error" } } } @@ -4141,6 +4111,36 @@ } } }, + "/api/v1/uma/scopes/search" : { + "get" : { + "summary" : "Search UMA scopes", + "description" : "Search uma scopes", + "operationId" : "searchUmaScopes", + "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/radius/clients" : { "get" : { "summary" : "Get all radius clients", @@ -4517,22 +4517,22 @@ "whitePagesCanView" : { "type" : "boolean" }, - "userCanEdit" : { + "adminCanAccess" : { "type" : "boolean" }, - "userCanView" : { + "adminCanView" : { "type" : "boolean" }, - "adminCanView" : { + "userCanEdit" : { "type" : "boolean" }, - "adminCanEdit" : { + "userCanAccess" : { "type" : "boolean" }, - "adminCanAccess" : { + "userCanView" : { "type" : "boolean" }, - "userCanAccess" : { + "adminCanEdit" : { "type" : "boolean" }, "baseDn" : { @@ -5761,13 +5761,13 @@ "internal" : { "type" : "boolean" }, - "locationPath" : { - "type" : "string" - }, "locationType" : { "type" : "string", "enum" : [ "ldap", "file" ] }, + "locationPath" : { + "type" : "string" + }, "baseDn" : { "type" : "string" } @@ -6586,71 +6586,174 @@ "frontChannelLogoutSessionSupported" : { "type" : "boolean" }, - "updateUserLastLogonTime" : { - "type" : "boolean" + "updateUserLastLogonTime" : { + "type" : "boolean" + }, + "updateClientAccessTime" : { + "type" : "boolean" + }, + "enableClientGrantTypeUpdate" : { + "type" : "boolean" + }, + "corsConfigurationFilters" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/CorsConfigurationFilter" + } + }, + "logClientIdOnClientAuthentication" : { + "type" : "boolean" + }, + "logClientNameOnClientAuthentication" : { + "type" : "boolean" + }, + "httpLoggingEnabled" : { + "type" : "boolean" + }, + "httpLoggingExludePaths" : { + "type" : "array", + "items" : { + "type" : "object" + } + }, + "externalLoggerConfiguration" : { + "type" : "string" + }, + "authorizationRequestCustomAllowedParameters" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "legacyDynamicRegistrationScopeParam" : { + "type" : "boolean" + }, + "openidScopeBackwardCompatibility" : { + "type" : "boolean" + }, + "useCacheForAllImplicitFlowObjects" : { + "type" : "boolean" + }, + "disableU2fEndpoint" : { + "type" : "boolean" + }, + "authenticationProtectionConfiguration" : { + "$ref" : "#/components/schemas/AuthenticationProtectionConfiguration" + }, + "fido2Configuration" : { + "$ref" : "#/components/schemas/Fido2Configuration" + }, + "loggingLevel" : { + "type" : "string" + }, + "errorHandlingMethod" : { + "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" }, - "updateClientAccessTime" : { + "ignoreValidation" : { "type" : "boolean" }, - "enableClientGrantTypeUpdate" : { - "type" : "boolean" + "umaIssuer" : { + "type" : "string" }, - "corsConfigurationFilters" : { - "type" : "array", - "items" : { - "$ref" : "#/components/schemas/CorsConfigurationFilter" - } + "cssLocation" : { + "type" : "string" }, - "logClientIdOnClientAuthentication" : { - "type" : "boolean" + "jsLocation" : { + "type" : "string" }, - "logClientNameOnClientAuthentication" : { + "enableUpdateNotification" : { "type" : "boolean" }, - "httpLoggingEnabled" : { + "oxIncommonFlag" : { "type" : "boolean" }, - "httpLoggingExludePaths" : { + "clientWhiteList" : { "type" : "array", "items" : { - "type" : "object" + "type" : "string" } }, - "externalLoggerConfiguration" : { - "type" : "string" - }, - "authorizationRequestCustomAllowedParameters" : { + "clientBlackList" : { "type" : "array", "items" : { "type" : "string" } }, - "legacyDynamicRegistrationScopeParam" : { - "type" : "boolean" - }, - "openidScopeBackwardCompatibility" : { - "type" : "boolean" + "loggingLevel" : { + "type" : "string" }, - "useCacheForAllImplicitFlowObjects" : { - "type" : "boolean" + "organizationName" : { + "type" : "string" }, - "disableU2fEndpoint" : { + "disableJdkLogger" : { "type" : "boolean" }, - "authenticationProtectionConfiguration" : { - "$ref" : "#/components/schemas/AuthenticationProtectionConfiguration" - }, - "fido2Configuration" : { - "$ref" : "#/components/schemas/Fido2Configuration" + "passwordResetRequestExpirationTime" : { + "type" : "integer", + "format" : "int32" }, - "loggingLevel" : { - "type" : "string" + "cleanServiceInterval" : { + "type" : "integer", + "format" : "int32" }, - "errorHandlingMethod" : { - "type" : "string" + "enforceEmailUniqueness" : { + "type" : "boolean" }, - "cookieDomain" : { - "type" : "string" + "useLocalCache" : { + "type" : "boolean" } } }, @@ -7019,109 +7122,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" - } - } - }, "OxTrustJsonSetting" : { "type" : "object", "properties" : { @@ -7545,12 +7545,6 @@ "type" : "string", "enum" : [ "disabled", "enabled", "false", "true", "inactive", "active" ] }, - "new" : { - "type" : "boolean" - }, - "multiValued" : { - "type" : "boolean" - }, "stringValue" : { "type" : "string" }, @@ -7560,23 +7554,29 @@ "type" : "string" } }, - "userCanEdit" : { + "multiValued" : { "type" : "boolean" }, - "userCanView" : { + "new" : { "type" : "boolean" }, - "adminCanView" : { + "adminCanAccess" : { "type" : "boolean" }, - "adminCanEdit" : { + "adminCanView" : { "type" : "boolean" }, - "adminCanAccess" : { + "userCanEdit" : { "type" : "boolean" }, "userCanAccess" : { "type" : "boolean" + }, + "userCanView" : { + "type" : "boolean" + }, + "adminCanEdit" : { + "type" : "boolean" } } }, @@ -7714,29 +7714,29 @@ "certificate" : { "type" : "string" }, - "uniqueGluuEntityId" : { - "uniqueItems" : true, - "type" : "array", - "writeOnly" : true, - "items" : { - "type" : "string" - } + "entityId" : { + "type" : "string" }, - "researchBundle" : { + "federation" : { "type" : "boolean" }, - "containerFederation" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" - }, "specificRelyingPartyConfig" : { "type" : "boolean" }, - "entityId" : { - "type" : "string" + "containerFederation" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" }, - "federation" : { + "researchBundle" : { "type" : "boolean" }, + "uniqueGluuEntityId" : { + "uniqueItems" : true, + "type" : "array", + "writeOnly" : true, + "items" : { + "type" : "string" + } + }, "baseDn" : { "type" : "string" } @@ -7843,6 +7843,23 @@ } } }, + "TrustContact" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "phone" : { + "type" : "string" + }, + "mail" : { + "type" : "string" + }, + "title" : { + "type" : "string" + } + } + }, "SAMLTrustRelationshipShort" : { "type" : "object", "properties" : { @@ -7867,23 +7884,6 @@ } } }, - "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 e97404126..1052311a6 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.1.sp1 paths: /configuration/api: get: @@ -116,23 +116,17 @@ paths: description: default response content: application/json: {} - /api/v1/attributes/search: + /api/v1/attributes/attribute/{inum}: get: - summary: Search attributes - description: Perform an attribute search - operationId: searchAttributes + summary: Get attribute by inum + description: Get an attribute by inum + operationId: getAttributeByInum parameters: - - name: pattern - in: query + - name: inum + in: path required: true schema: type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 1 responses: 200: description: success @@ -145,17 +139,23 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.attribute.read - /api/v1/attributes/attribute/{inum}: + /api/v1/attributes/search: get: - summary: Get attribute by inum - description: Get an attribute by inum - operationId: getAttributeByInum + summary: Search attributes + description: Perform an attribute search + operationId: searchAttributes 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: description: success @@ -455,39 +455,49 @@ paths: description: default response content: application/json: {} - /api/v1/clients/{inum}: - get: - summary: Get OIDC client - description: Get a specific OIDC client - operationId: getClientByInum + /api/v1/clients/{inum}/scopes/{sinum}: + post: + summary: Add OIDC client scopes + description: Add scopes to OIDC client + operationId: addScopeToClient parameters: - name: inum in: path required: true schema: type: string + - name: sinum + in: path + required: true + schema: + type: string responses: 200: description: Success content: application/json: schema: - $ref: '#/components/schemas/OxAuthClient' + type: string 500: description: Server error security: - oauth2: - - https://gluu.org/auth/oxtrust.client.read + - https://gluu.org/auth/oxtrust.client.write delete: - summary: 'Delete OIDC client ' - description: Delete an openidconnect client - operationId: deleteClient + summary: Remove OIDC client scope + description: Remove an existing scope from client + operationId: removeScopeToClient parameters: - name: inum in: path required: true schema: type: string + - name: sinum + in: path + required: true + schema: + type: string responses: 200: description: Success @@ -500,51 +510,39 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.client.write - /api/v1/clients/search: + /api/v1/clients/{inum}: get: - summary: Search OIDC clients - description: Search OIDC clients - operationId: searchClients + summary: Get OIDC client + description: Get a specific OIDC client + operationId: getClientByInum parameters: - - name: pattern - in: query + - name: inum + in: path 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 + $ref: '#/components/schemas/OxAuthClient' 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 - description: Add scopes to OIDC client - operationId: addScopeToClient + delete: + summary: 'Delete OIDC client ' + description: Delete an openidconnect client + operationId: deleteClient parameters: - name: inum in: path required: true schema: type: string - - name: sinum - in: path - required: true - schema: - type: string responses: 200: description: Success @@ -557,21 +555,23 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.client.write - delete: - summary: Remove OIDC client scope - description: Remove an existing scope from client - operationId: removeScopeToClient + /api/v1/clients/search: + get: + 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: sinum - in: path - required: true + - name: size + in: query schema: - type: string + type: integer + format: int32 + default: 1 responses: 200: description: Success @@ -583,7 +583,7 @@ paths: description: Server error security: - oauth2: - - https://gluu.org/auth/oxtrust.client.write + - https://gluu.org/auth/oxtrust.client.read /api/v1/configuration: get: summary: Get gluu configuration @@ -772,62 +772,58 @@ paths: $ref: '#/components/schemas/GluuGroupApi' 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}: + get: + summary: Get group by inum + description: Get a group by inum + operationId: getGroupByInum parameters: - name: inum in: path required: true schema: type: string - - name: minum - in: path - required: true - schema: - type: string responses: 200: description: Success content: application/json: schema: - type: string + $ref: '#/components/schemas/GluuGroupApi' 500: description: Server error delete: - summary: Remove group member - description: Remove a member from group - operationId: removeGroupMember + summary: Delete group + description: Delete a group + operationId: deleteGroup 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 - /api/v1/groups/{inum}/members: + /api/v1/groups/search: get: - summary: Get group members - description: Get a group members - operationId: getGroupMembers + summary: Search groups + description: Search groups + operationId: searchGroups 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: description: Success @@ -837,28 +833,18 @@ paths: type: string 500: description: Server error - delete: - summary: Delete group member - description: Delete group member - operationId: deleteGroupMembers + /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 - responses: - default: - description: default response - content: - application/json: {} - /api/v1/groups/{inum}: - get: - summary: Get group by inum - description: Get a group by inum - operationId: getGroupByInum - parameters: - - name: inum + - name: minum in: path required: true schema: @@ -869,41 +855,40 @@ 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: Remove group member + description: Remove a member from group + operationId: removeGroupMember 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 - /api/v1/groups/search: + /api/v1/groups/{inum}/members: get: - summary: Search groups - description: Search groups - operationId: searchGroups + summary: Get group members + description: Get a group members + operationId: getGroupMembers parameters: - - name: pattern - in: query + - name: inum + in: path required: true schema: type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 1 responses: 200: description: Success @@ -913,6 +898,21 @@ paths: type: string 500: description: Server error + delete: + 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: {} /configuration/idp: get: summary: Retrieve idp configuration @@ -991,23 +991,6 @@ 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' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/ConnectionStatusDTO' /api/v1/configuration/ldap/{name}: delete: summary: Delete an existing configuration @@ -1026,7 +1009,24 @@ paths: application/json: schema: type: string - /api/v1/configuration/ldap/{name}/status: + /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 + content: + 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 @@ -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 @@ -1722,26 +1722,6 @@ paths: type: string 500: description: Server error - /api/v1/sectoridentifiers/sector/{id}: - get: - summary: Get sector identifier - description: Get a sector identifier - operationId: getSectorIdentifierById - parameters: - - name: id - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/OxAuthSectorIdentifier' - 500: - description: Server error /api/v1/sectoridentifiers: get: summary: Get all sector identifiers @@ -1792,6 +1772,26 @@ paths: $ref: '#/components/schemas/OxAuthSectorIdentifier' 500: description: Server error + /api/v1/sectoridentifiers/sector/{id}: + get: + summary: Get sector identifier + description: Get a sector identifier + operationId: getSectorIdentifierById + parameters: + - name: id + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OxAuthSectorIdentifier' + 500: + description: Server error /api/v1/sectoridentifiers/{inum}: delete: summary: Delete sector identifier @@ -2016,6 +2016,29 @@ paths: description: OK 500: description: Server error + /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 + 500: + description: Server error /api/v1/saml/tr/remove_attribute: delete: operationId: removeAttribute @@ -2029,9 +2052,12 @@ paths: description: default response content: text/plain: {} - /api/v1/saml/tr/set_metadata/{inum}: + /api/v1/saml/tr/set_contacts/{inum}: post: - operationId: setMetadata + summary: set contacts for TrustRelationship + description: Find TrustRelationship by inum and set contacts. Contacts parameter + is List + operationId: setContacts parameters: - name: inum in: path @@ -2040,9 +2066,55 @@ paths: type: string requestBody: content: - application/xml: + application/json: schema: type: string + responses: + 200: + description: OK + 500: + description: Server error + /api/v1/saml/tr/get_contacts/{inum}: + get: + operationId: getContacts + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: OK + content: + text/plain: + schema: + type: string + 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/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 @@ -2073,9 +2145,15 @@ paths: description: OK 500: description: Server error - /api/v1/saml/tr/list_all_active_trust_relationships: + /api/v1/saml/tr/list_all_saml_trust_relationships: get: - operationId: listAllActiveTrustRelationships + operationId: listAllSAMLTrustRelationships + parameters: + - name: size_limit + in: query + schema: + type: integer + format: int32 responses: 200: description: OK @@ -2113,15 +2191,9 @@ paths: description: OK 500: description: Server error - /api/v1/saml/tr/list_all_saml_trust_relationships: + /api/v1/saml/tr/list_all_active_trust_relationships: get: - operationId: listAllSAMLTrustRelationships - parameters: - - name: size_limit - in: query - schema: - type: integer - format: int32 + operationId: listAllActiveTrustRelationships responses: 200: description: OK @@ -2154,15 +2226,9 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/get_contacts/{inum}: + /api/v1/saml/tr/generate_inum_for_new_trust_relationship: get: - operationId: getContacts - parameters: - - name: inum - in: path - required: true - schema: - type: string + operationId: generateInumForNewTrustRelationship responses: 200: description: OK @@ -2172,60 +2238,6 @@ paths: 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 - 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: - get: - operationId: listAllFederations - responses: - 200: - description: OK - content: - application/json: - schema: - type: string - 500: - description: Server error /api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}: get: operationId: listDeconstructedTrustRelationships @@ -2244,18 +2256,6 @@ paths: type: string 500: description: Server error - /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/inbound-saml/trusted-idp: get: summary: Retrieve all trusted-idps @@ -2375,103 +2375,17 @@ paths: description: Resource not Found 500: description: Server error - /api/v1/uma/resources/{id}/clients/{inum}: - post: - summary: Add UMA resource client - description: add client to uma resource - operationId: addClientToUmaResource - parameters: - - name: id - in: path - required: true - schema: - type: string - - name: inum - in: path - required: true - schema: - type: string - responses: - 201: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' - 500: - description: Server error - delete: - summary: Remove UMA resource client - description: Remove client from uma resource - operationId: removeClientToUmaResource - parameters: - - name: id - in: path - required: true - schema: - type: string - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' - 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}/clients: + /api/v1/uma/resources/{id}: 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/{inum}: - post: - summary: Add UMA resource scope - description: add scope to uma resource - operationId: addScopeToUmaResource + summary: Get UMA resource by id + description: Get a uma resource by id + operationId: getUmaResourceById parameters: - name: id in: path required: true schema: type: string - - name: inum - in: path - required: true - schema: - type: string responses: 200: description: Success @@ -2482,27 +2396,18 @@ paths: 500: description: Server error delete: - summary: Remove UMA resource scope - description: remove a scope from uma resource - operationId: removeScopeToUmaResource + summary: Delete UMA resource + description: Delete a uma resource + operationId: deleteUmaResource parameters: - name: id in: path required: true schema: type: string - - name: inum - in: path - required: true - schema: - type: string responses: 200: description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' 500: description: Server error /api/v1/uma/resources/search: @@ -2581,17 +2486,22 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error - /api/v1/uma/resources/{id}: - get: - summary: Get UMA resource by id - description: Get a uma resource by id - operationId: getUmaResourceById + /api/v1/uma/resources/{id}/scopes/{inum}: + post: + summary: Add UMA resource scope + description: add scope to uma resource + operationId: addScopeToUmaResource parameters: - name: id in: path required: true schema: type: string + - name: inum + in: path + required: true + schema: + type: string responses: 200: description: Success @@ -2602,40 +2512,110 @@ paths: 500: description: Server error delete: - summary: Delete UMA resource - description: Delete a uma resource - operationId: deleteUmaResource + summary: Remove UMA resource scope + description: remove a scope from uma resource + operationId: removeScopeToUmaResource parameters: - name: id in: path required: true schema: type: string + - name: inum + in: path + required: true + schema: + type: string responses: 200: description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' 500: description: Server error - /api/v1/uma/scopes/search: + /api/v1/uma/resources/{id}/clients: get: - summary: Search UMA scopes - description: Search uma scopes - operationId: searchUmaScopes + summary: Get clients of UMA resources + description: Get clients of uma resource + operationId: getUmaResourceClients parameters: - - name: pattern - in: query + - name: id + in: path + required: true + schema: + type: string + responses: + default: + description: default response + content: + application/json: {} + /api/v1/uma/resources/{id}/clients/{inum}: + post: + summary: Add UMA resource client + description: add client to uma resource + operationId: addClientToUmaResource + parameters: + - name: id + in: path + required: true + schema: + type: string + - name: inum + in: path + required: true + schema: + type: string + responses: + 201: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' + 500: + description: Server error + delete: + summary: Remove UMA resource client + description: Remove client from uma resource + operationId: removeClientToUmaResource + parameters: + - name: id + in: path + required: true + schema: + type: string + - name: inum + in: path required: true schema: type: string responses: 200: - description: success + description: Success content: application/json: schema: - type: string + $ref: '#/components/schemas/UmaResource' 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/scopes: get: summary: Get UMA scopes @@ -2721,6 +2701,26 @@ paths: description: success 500: description: Server error + /api/v1/uma/scopes/search: + get: + summary: Search UMA scopes + description: Search uma scopes + operationId: searchUmaScopes + 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/radius/clients: get: summary: Get all radius clients @@ -3000,18 +3000,18 @@ components: type: string whitePagesCanView: type: boolean - userCanEdit: - type: boolean - userCanView: + adminCanAccess: type: boolean adminCanView: type: boolean - adminCanEdit: - type: boolean - adminCanAccess: + userCanEdit: type: boolean userCanAccess: type: boolean + userCanView: + type: boolean + adminCanEdit: + type: boolean baseDn: type: string AuthenticationMethod: @@ -4027,13 +4027,13 @@ components: type: boolean internal: type: boolean - locationPath: - type: string locationType: type: string enum: - ldap - file + locationPath: + type: string baseDn: type: string ScriptError: @@ -4638,6 +4638,75 @@ 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: @@ -4892,75 +4961,6 @@ 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: @@ -5261,28 +5261,28 @@ components: - "true" - inactive - active - new: - type: boolean - multiValued: - type: boolean stringValue: type: string stringValues: type: array items: type: string - userCanEdit: + multiValued: type: boolean - userCanView: + new: type: boolean - adminCanView: + adminCanAccess: type: boolean - adminCanEdit: + adminCanView: type: boolean - adminCanAccess: + userCanEdit: type: boolean userCanAccess: type: boolean + userCanView: + type: boolean + adminCanEdit: + type: boolean GluuSAMLTrustRelationship: required: - description @@ -5395,22 +5395,22 @@ components: type: string certificate: type: string + entityId: + type: string + federation: + type: boolean + specificRelyingPartyConfig: + type: boolean + containerFederation: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' + researchBundle: + type: boolean uniqueGluuEntityId: uniqueItems: true type: array writeOnly: true items: type: string - researchBundle: - type: boolean - containerFederation: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' - specificRelyingPartyConfig: - type: boolean - entityId: - type: string - federation: - type: boolean baseDn: type: string writeOnly: true @@ -5481,6 +5481,17 @@ components: type: array items: type: string + TrustContact: + type: object + properties: + name: + type: string + phone: + type: string + mail: + type: string + title: + type: string SAMLTrustRelationshipShort: type: object properties: @@ -5501,17 +5512,6 @@ components: 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: