From b0f1a31ed194b38b33b43b7a7aee8bb016681031 Mon Sep 17 00:00:00 2001 From: shekhar16 Date: Fri, 24 Nov 2023 01:45:23 +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 | 1662 ++++++++--------- .../src/main/resources/META-INF/openapi.yaml | 1168 ++++++------ 3 files changed, 1419 insertions(+), 1419 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..e90c80311 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.3", 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 bf86a349f..f5850f3e6 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.3" }, "paths" : { "/configuration/api" : { @@ -173,11 +173,11 @@ } } }, - "/api/v1/attributes/active" : { + "/api/v1/attributes/inactive" : { "get" : { - "summary" : "Get all active attributes", - "description" : "Gets all the active gluu attributes", - "operationId" : "getAllActiveAttributes", + "summary" : "Get all inactive attributes", + "description" : "Gets all inative attributes", + "operationId" : "getAllInactiveAttributes", "responses" : { "200" : { "description" : "success", @@ -198,11 +198,11 @@ } ] } }, - "/api/v1/attributes/inactive" : { + "/api/v1/attributes/active" : { "get" : { - "summary" : "Get all inactive attributes", - "description" : "Gets all inative attributes", - "operationId" : "getAllInactiveAttributes", + "summary" : "Get all active attributes", + "description" : "Gets all the active gluu attributes", + "operationId" : "getAllActiveAttributes", "responses" : { "200" : { "description" : "success", @@ -223,6 +223,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", @@ -297,35 +326,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/acrs" : { "get" : { "summary" : "Get current authentication methods", @@ -516,84 +516,6 @@ } ] } }, - "/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" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - }, - "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] - } ] - }, - "delete" : { - "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", - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "500" : { - "description" : "Server error" - } - }, - "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] - } ] - } - }, "/api/v1/clients" : { "get" : { "summary" : "Get openid connect clients", @@ -694,11 +616,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", @@ -706,32 +628,8 @@ "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", + }, { + "name" : "sinum", "in" : "path", "required" : true, "schema" : { @@ -756,13 +654,11 @@ "security" : [ { "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] } ] - } - }, - "/api/v1/clients/{inum}/scopes" : { - "get" : { - "summary" : "Get assigned OIDC client scopes", - "description" : "Get OIDC scopes assign to OIDC client", - "operationId" : "getClientScope", + }, + "delete" : { + "summary" : "Remove OIDC client scope", + "description" : "Remove an existing scope from client", + "operationId" : "removeScopeToClient", "parameters" : [ { "name" : "inum", "in" : "path", @@ -770,6 +666,13 @@ "schema" : { "type" : "string" } + }, { + "name" : "sinum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -784,33 +687,11 @@ }, "500" : { "description" : "Server error" - }, - "404" : { - "description" : "Not Found" } }, "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] } ] - }, - "delete" : { - "operationId" : "deleteClientScopes", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "description" : "default response", - "content" : { - "application/json" : { } - } - } - } } }, "/api/v1/clients/search" : { @@ -854,18 +735,26 @@ } ] } }, - "/api/v1/configuration" : { + "/api/v1/clients/{inum}" : { "get" : { - "summary" : "Get gluu configuration", - "description" : "Retrieve gluu configuration", - "operationId" : "getConfiguration", + "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", + "description" : "Success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuConfiguration" + "$ref" : "#/components/schemas/OxAuthClient" } } } @@ -875,9 +764,120 @@ } }, "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.configuration.read" ] + "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" : { + "get" : { + "summary" : "Get assigned OIDC client scopes", + "description" : "Get OIDC scopes assign to OIDC client", + "operationId" : "getClientScope", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + }, + "404" : { + "description" : "Not Found" + } + }, + "security" : [ { + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] + } ] + }, + "delete" : { + "operationId" : "deleteClientScopes", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "default" : { + "description" : "default response", + "content" : { + "application/json" : { } + } + } + } + } + }, + "/api/v1/configuration" : { + "get" : { + "summary" : "Get gluu configuration", + "description" : "Retrieve gluu configuration", + "operationId" : "getConfiguration", + "responses" : { + "200" : { + "description" : "success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuConfiguration" + } + } + } + }, + "500" : { + "description" : "Server error" + } + }, + "security" : [ { + "oauth2" : [ "https://gluu.org/auth/oxtrust.configuration.read" ] + } ] + } }, "/api/v1/configuration/scripts/{inum}" : { "get" : { @@ -1138,6 +1138,57 @@ } } }, + "/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/{inum}/members" : { "get" : { "summary" : "Get group members", @@ -1292,57 +1343,6 @@ } } }, - "/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" - } - } - } - }, "/configuration/idp" : { "get" : { "summary" : "Retrieve idp configuration", @@ -1468,6 +1468,33 @@ } } }, + "/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", @@ -1496,11 +1523,11 @@ } } }, - "/api/v1/configuration/ldap/{name}" : { - "delete" : { - "summary" : "Delete an existing configuration", - "description" : "Delete an existing configuration", - "operationId" : "deleteLdapConfigurationByName", + "/api/v1/configuration/ldap/{name}/status" : { + "get" : { + "summary" : "Check the status of an existing configuration", + "description" : "Check the status of an existing configuration", + "operationId" : "getLdapConfigurationStatusByName", "parameters" : [ { "name" : "name", "in" : "path", @@ -1515,7 +1542,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/ConnectionStatusDTO" } } } @@ -1523,34 +1550,7 @@ } } }, - "/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", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/ConnectionStatusDTO" - } - } - } - } - } - } - }, - "/configuration/metric" : { + "/configuration/metric" : { "get" : { "summary" : "Retrieve metric configuration", "description" : "Retrieve metric configuration", @@ -2160,36 +2160,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" - } - } - } - }, "/api/v1/users" : { "get" : { "summary" : "Get people", @@ -2270,6 +2240,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" + } + } + } + }, "/configuration/rpt" : { "get" : { "summary" : "Retrieve rpt configuration", @@ -2570,6 +2570,43 @@ } } }, + "/api/v1/sectoridentifiers/search" : { + "get" : { + "summary" : "Search sector identifiers", + "description" : "Search sectors identifiers", + "operationId" : "searchSectorIdentifier", + "parameters" : [ { + "name" : "pattern", + "in" : "query", + "schema" : { + "type" : "string" + } + }, { + "name" : "size", + "in" : "query", + "schema" : { + "type" : "integer", + "format" : "int32", + "default" : 10 + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, "/api/v1/sectoridentifiers" : { "get" : { "summary" : "Get all sector identifiers", @@ -2650,13 +2687,13 @@ } } }, - "/api/v1/sectoridentifiers/sector/{id}" : { - "get" : { - "summary" : "Get sector identifier", - "description" : "Get a sector identifier", - "operationId" : "getSectorIdentifierById", + "/api/v1/sectoridentifiers/{inum}" : { + "delete" : { + "summary" : "Delete sector identifier", + "description" : "Delete a sector identifier", + "operationId" : "deleteSectorIdentifier", "parameters" : [ { - "name" : "id", + "name" : "inum", "in" : "path", "required" : true, "schema" : { @@ -2665,14 +2702,7 @@ } ], "responses" : { "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/OxAuthSectorIdentifier" - } - } - } + "description" : "Success" }, "500" : { "description" : "Server error" @@ -2680,25 +2710,18 @@ } } }, - "/api/v1/sectoridentifiers/search" : { + "/api/v1/sectoridentifiers/sector/{id}" : { "get" : { - "summary" : "Search sector identifiers", - "description" : "Search sectors identifiers", - "operationId" : "searchSectorIdentifier", + "summary" : "Get sector identifier", + "description" : "Get a sector identifier", + "operationId" : "getSectorIdentifierById", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "id", + "in" : "path", + "required" : true, "schema" : { "type" : "string" } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 10 - } } ], "responses" : { "200" : { @@ -2706,7 +2729,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/OxAuthSectorIdentifier" } } } @@ -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", @@ -3065,54 +3065,6 @@ } } }, - "/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/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/set_metadata/{inum}" : { "post" : { "operationId" : "setMetadata", @@ -3171,11 +3123,9 @@ } } }, - "/api/v1/saml/tr/set_certificate/{inum}" : { - "post" : { - "summary" : "set certificate for TrustRelationship", - "description" : "Find TrustRelationship by inum and set certificate.", - "operationId" : "setCertificate", + "/api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}" : { + "get" : { + "operationId" : "listDeconstructedTrustRelationships", "parameters" : [ { "name" : "inum", "in" : "path", @@ -3184,18 +3134,16 @@ "type" : "string" } } ], - "requestBody" : { - "content" : { - "text/plain" : { - "schema" : { - "type" : "string" - } - } - } - }, "responses" : { "200" : { - "description" : "OK" + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } }, "500" : { "description" : "Server error" @@ -3203,17 +3151,9 @@ } } }, - "/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", @@ -3231,9 +3171,11 @@ } } }, - "/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", @@ -3249,8 +3191,7 @@ "type" : "string" } } - }, - "required" : true + } }, "responses" : { "200" : { @@ -3262,9 +3203,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", @@ -3282,28 +3231,46 @@ } } }, - "/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", + "/api/v1/saml/tr/search_trust_relationships" : { + "get" : { + "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" + } } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" + "responses" : { + "200" : { + "description" : "OK", + "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" @@ -3342,11 +3309,47 @@ } } }, - "/api/v1/saml/tr/generate_configuration_files" : { - "put" : { - "summary" : "generate configuration files", - "description" : "Generate configuration files for Shibboleth IDP", - "operationId" : "generateConfigurationFiles", + "/api/v1/saml/tr/list_all_active_trust_relationships" : { + "get" : { + "operationId" : "listAllActiveTrustRelationships", + "responses" : { + "200" : { + "description" : "OK", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/saml/tr/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" @@ -3357,14 +3360,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" } @@ -3377,17 +3388,9 @@ } } }, - "/api/v1/saml/tr/list_all_saml_trust_relationships" : { + "/api/v1/saml/tr/list_all_federations" : { "get" : { - "operationId" : "listAllSAMLTrustRelationships", - "parameters" : [ { - "name" : "size_limit", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32" - } - } ], + "operationId" : "listAllFederations", "responses" : { "200" : { "description" : "OK", @@ -3405,34 +3408,31 @@ } } }, - "/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" @@ -3621,34 +3621,33 @@ } } }, - "/api/v1/uma/resources/search" : { - "get" : { - "summary" : "Search UMA resources", - "description" : "Search uma resources", - "operationId" : "searchUmaResources", + "/api/v1/uma/resources/{id}/clients/{inum}" : { + "post" : { + "summary" : "Add UMA resource client", + "description" : "add client to uma resource", + "operationId" : "addClientToUmaResource", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "id", + "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { - "name" : "size", - "in" : "query", + "name" : "inum", + "in" : "path", "required" : true, "schema" : { - "type" : "integer", - "format" : "int32" + "type" : "string" } } ], "responses" : { - "200" : { + "201" : { "description" : "Success", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/UmaResource" } } } @@ -3657,13 +3656,11 @@ "description" : "Server error" } } - } - }, - "/api/v1/uma/resources/{id}" : { - "get" : { - "summary" : "Get UMA resource by id", - "description" : "Get a uma resource by id", - "operationId" : "getUmaResourceById", + }, + "delete" : { + "summary" : "Remove UMA resource client", + "description" : "Remove client from uma resource", + "operationId" : "removeClientToUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3671,6 +3668,13 @@ "schema" : { "type" : "string" } + }, { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -3687,11 +3691,13 @@ "description" : "Server error" } } - }, - "delete" : { - "summary" : "Delete UMA resource", - "description" : "Delete a uma resource", - "operationId" : "deleteUmaResource", + } + }, + "/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", @@ -3699,15 +3705,110 @@ "schema" : { "type" : "string" } - } ], - "responses" : { - "200" : { - "description" : "Success" - }, - "500" : { + }, { + "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", + "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" : { + "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" : { @@ -3790,11 +3891,11 @@ } } }, - "/api/v1/uma/resources/{id}/scopes/{inum}" : { - "post" : { - "summary" : "Add UMA resource scope", - "description" : "add scope to uma resource", - "operationId" : "addScopeToUmaResource", + "/api/v1/uma/resources/{id}" : { + "get" : { + "summary" : "Get UMA resource by id", + "description" : "Get a uma resource by id", + "operationId" : "getUmaResourceById", "parameters" : [ { "name" : "id", "in" : "path", @@ -3802,13 +3903,6 @@ "schema" : { "type" : "string" } - }, { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { @@ -3827,9 +3921,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", @@ -3837,24 +3931,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" @@ -3862,82 +3942,25 @@ } } }, - "/api/v1/uma/resources/{id}/scopes" : { + "/api/v1/uma/resources/search" : { "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/{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", + "summary" : "Search UMA resources", + "description" : "Search uma resources", + "operationId" : "searchUmaResources", "parameters" : [ { - "name" : "id", - "in" : "path", + "name" : "pattern", + "in" : "query", "required" : true, "schema" : { "type" : "string" } }, { - "name" : "inum", - "in" : "path", + "name" : "size", + "in" : "query", "required" : true, "schema" : { - "type" : "string" + "type" : "integer", + "format" : "int32" } } ], "responses" : { @@ -3946,7 +3969,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/UmaResource" + "type" : "string" } } } @@ -3957,29 +3980,6 @@ } } }, - "/api/v1/uma/resources/{id}/clients" : { - "get" : { - "summary" : "Get clients of UMA resources", - "description" : "Get clients of uma resource", - "operationId" : "getUmaResourceClients", - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "default" : { - "description" : "default response", - "content" : { - "application/json" : { } - } - } - } - } - }, "/api/v1/uma/scopes/{inum}" : { "get" : { "summary" : "Get UMA scope by inum", @@ -4141,6 +4141,69 @@ } } }, + "/api/v1/radius/clients/{inum}" : { + "get" : { + "summary" : "Get radius client by inum", + "description" : "Get radius client by inum", + "operationId" : "getRadiusClient", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/RadiusClient" + } + } + } + }, + "403" : { + "description" : "Gluu Radius is not installed" + }, + "404" : { + "description" : "Radius client not found" + }, + "500" : { + "description" : "Internal server error" + } + } + }, + "delete" : { + "summary" : "Delete radius client", + "description" : "Deletes a radius client", + "operationId" : "deleteRadiusClient", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "204" : { + "description" : "Success" + }, + "403" : { + "description" : "Gluu Radius is not installed" + }, + "404" : { + "description" : "Radius client not found" + }, + "500" : { + "description" : "Internal server error" + } + } + } + }, "/api/v1/radius/clients" : { "get" : { "summary" : "Get all radius clients", @@ -4222,80 +4285,17 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/RadiusClient" - } - } - } - }, - "400" : { - "description" : "Malformed request. Missing parameter" - }, - "403" : { - "description" : "Gluu Radius is not installed" - }, - "500" : { - "description" : "Internal server error" - } - } - } - }, - "/api/v1/radius/clients/{inum}" : { - "get" : { - "summary" : "Get radius client by inum", - "description" : "Get radius client by inum", - "operationId" : "getRadiusClient", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/RadiusClient" - } - } - } - }, - "403" : { - "description" : "Gluu Radius is not installed" - }, - "404" : { - "description" : "Radius client not found" - }, - "500" : { - "description" : "Internal server error" - } - } - }, - "delete" : { - "summary" : "Delete radius client", - "description" : "Deletes a radius client", - "operationId" : "deleteRadiusClient", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "204" : { - "description" : "Success" + "$ref" : "#/components/schemas/RadiusClient" + } + } + } + }, + "400" : { + "description" : "Malformed request. Missing parameter" }, "403" : { "description" : "Gluu Radius is not installed" }, - "404" : { - "description" : "Radius client not found" - }, "500" : { "description" : "Internal server error" } @@ -4514,22 +4514,22 @@ "gluuTooltip" : { "type" : "string" }, - "adminCanAccess" : { + "adminCanEdit" : { "type" : "boolean" }, - "adminCanView" : { + "userCanEdit" : { "type" : "boolean" }, - "adminCanEdit" : { + "userCanAccess" : { "type" : "boolean" }, - "userCanEdit" : { + "adminCanAccess" : { "type" : "boolean" }, - "userCanView" : { + "adminCanView" : { "type" : "boolean" }, - "userCanAccess" : { + "userCanView" : { "type" : "boolean" }, "whitePagesCanView" : { @@ -4673,90 +4673,6 @@ } } }, - "Scope" : { - "type" : "object", - "properties" : { - "dn" : { - "type" : "string" - }, - "expirationDate" : { - "type" : "string", - "format" : "date-time" - }, - "deletable" : { - "type" : "boolean" - }, - "inum" : { - "type" : "string" - }, - "displayName" : { - "type" : "string" - }, - "id" : { - "type" : "string" - }, - "iconUrl" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "scopeType" : { - "type" : "string", - "enum" : [ "openid", "dynamic", "uma", "spontaneous", "oauth" ] - }, - "oxAuthClaims" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "defaultScope" : { - "type" : "boolean" - }, - "oxAuthGroupClaims" : { - "type" : "boolean" - }, - "dynamicScopeScripts" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "umaAuthorizationPolicies" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "attributes" : { - "$ref" : "#/components/schemas/ScopeAttributes" - }, - "umaType" : { - "type" : "boolean" - }, - "baseDn" : { - "type" : "string" - } - } - }, - "ScopeAttributes" : { - "type" : "object", - "properties" : { - "spontaneousClientId" : { - "type" : "string" - }, - "spontaneousClientScopes" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "showInConfigurationEndpoint" : { - "type" : "boolean" - } - } - }, "ClientAttributes" : { "type" : "object", "properties" : { @@ -5100,6 +5016,90 @@ } } }, + "Scope" : { + "type" : "object", + "properties" : { + "dn" : { + "type" : "string" + }, + "expirationDate" : { + "type" : "string", + "format" : "date-time" + }, + "deletable" : { + "type" : "boolean" + }, + "inum" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "id" : { + "type" : "string" + }, + "iconUrl" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "scopeType" : { + "type" : "string", + "enum" : [ "openid", "dynamic", "uma", "spontaneous", "oauth" ] + }, + "oxAuthClaims" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "defaultScope" : { + "type" : "boolean" + }, + "oxAuthGroupClaims" : { + "type" : "boolean" + }, + "dynamicScopeScripts" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "umaAuthorizationPolicies" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "attributes" : { + "$ref" : "#/components/schemas/ScopeAttributes" + }, + "umaType" : { + "type" : "boolean" + }, + "baseDn" : { + "type" : "string" + } + } + }, + "ScopeAttributes" : { + "type" : "object", + "properties" : { + "spontaneousClientId" : { + "type" : "string" + }, + "spontaneousClientScopes" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "showInConfigurationEndpoint" : { + "type" : "boolean" + } + } + }, "CacheConfiguration" : { "type" : "object", "properties" : { @@ -5767,13 +5767,13 @@ "internal" : { "type" : "boolean" }, + "locationPath" : { + "type" : "string" + }, "locationType" : { "type" : "string", "enum" : [ "ldap", "file" ] }, - "locationPath" : { - "type" : "string" - }, "baseDn" : { "type" : "string" } @@ -7551,19 +7551,10 @@ "type" : "string", "enum" : [ "disabled", "enabled", "false", "true", "inactive", "active" ] }, - "stringValues" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "stringValue" : { - "type" : "string" - }, - "adminCanAccess" : { + "multiValued" : { "type" : "boolean" }, - "adminCanView" : { + "new" : { "type" : "boolean" }, "adminCanEdit" : { @@ -7572,17 +7563,26 @@ "userCanEdit" : { "type" : "boolean" }, - "userCanView" : { + "userCanAccess" : { "type" : "boolean" }, - "userCanAccess" : { + "adminCanAccess" : { "type" : "boolean" }, - "multiValued" : { + "adminCanView" : { "type" : "boolean" }, - "new" : { + "userCanView" : { "type" : "boolean" + }, + "stringValues" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "stringValue" : { + "type" : "string" } } }, @@ -7720,21 +7720,6 @@ "certificate" : { "type" : "string" }, - "specificRelyingPartyConfig" : { - "type" : "boolean" - }, - "containerFederation" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" - }, - "researchBundle" : { - "type" : "boolean" - }, - "entityId" : { - "type" : "string" - }, - "federation" : { - "type" : "boolean" - }, "uniqueGluuEntityId" : { "uniqueItems" : true, "type" : "array", @@ -7743,6 +7728,21 @@ "type" : "string" } }, + "entityId" : { + "type" : "string" + }, + "federation" : { + "type" : "boolean" + }, + "researchBundle" : { + "type" : "boolean" + }, + "specificRelyingPartyConfig" : { + "type" : "boolean" + }, + "containerFederation" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + }, "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 d0ae92f0e..d0140bda7 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.3 paths: /configuration/api: get: @@ -116,11 +116,11 @@ paths: description: default response content: application/json: {} - /api/v1/attributes/active: + /api/v1/attributes/inactive: get: - summary: Get all active attributes - description: Gets all the active gluu attributes - operationId: getAllActiveAttributes + summary: Get all inactive attributes + description: Gets all inative attributes + operationId: getAllInactiveAttributes responses: 200: description: success @@ -133,11 +133,11 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.attribute.read - /api/v1/attributes/inactive: + /api/v1/attributes/active: get: - summary: Get all inactive attributes - description: Gets all inative attributes - operationId: getAllInactiveAttributes + summary: Get all active attributes + description: Gets all the active gluu attributes + operationId: getAllActiveAttributes responses: 200: description: success @@ -150,6 +150,27 @@ 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/search: get: summary: Search attributes @@ -202,27 +223,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/acrs: get: summary: Get current authentication methods @@ -351,6 +351,72 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.certificates.read + /api/v1/clients: + get: + summary: Get openid connect clients + description: Get openid connect clients + operationId: listClients + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.client.read + put: + summary: Update OIDC client + description: Update openidconnect client + operationId: updateClient + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OxAuthClient' + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OxAuthClient' + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.client.write + post: + summary: Add OIDC client + description: Add an openidconnect client + operationId: createClient + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/OxAuthClient' + responses: + 201: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/OxAuthClient' + 500: + description: Server error + security: + - oauth2: + - https://gluu.org/auth/oxtrust.client.write + delete: + operationId: deleteClients + responses: + default: + description: default response + content: + application/json: {} /api/v1/clients/{inum}/scopes/{sinum}: post: summary: Add OIDC client scopes @@ -406,11 +472,23 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.client.write - /api/v1/clients: + /api/v1/clients/search: get: - summary: Get openid connect clients - description: Get openid connect clients - operationId: listClients + summary: Search OIDC clients + description: Search OIDC clients + operationId: searchClients + parameters: + - name: pattern + in: query + required: true + schema: + type: string + - name: size + in: query + schema: + type: integer + format: int32 + default: 1 responses: 200: description: Success @@ -423,55 +501,6 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.client.read - put: - summary: Update OIDC client - description: Update openidconnect client - operationId: updateClient - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OxAuthClient' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/OxAuthClient' - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.client.write - post: - summary: Add OIDC client - description: Add an openidconnect client - operationId: createClient - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/OxAuthClient' - responses: - 201: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/OxAuthClient' - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.client.write - delete: - operationId: deleteClients - responses: - default: - description: default response - content: - application/json: {} /api/v1/clients/{inum}: get: summary: Get OIDC client @@ -555,35 +584,6 @@ paths: description: default response content: application/json: {} - /api/v1/clients/search: - get: - summary: Search OIDC clients - description: Search OIDC clients - operationId: searchClients - parameters: - - name: pattern - in: query - required: true - schema: - type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 1 - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error - security: - - oauth2: - - https://gluu.org/auth/oxtrust.client.read /api/v1/configuration: get: summary: Get gluu configuration @@ -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,50 @@ paths: schema: type: string responses: - default: - description: default response - content: - application/json: {} - /api/v1/groups/{inum}/members/{minum}: - post: - summary: Add group member - description: Add group member - operationId: addGroupMember + 200: + description: Success + 500: + description: Server error + /api/v1/groups/{inum}/members: + get: + summary: Get group members + description: Get a group members + operationId: getGroupMembers + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + content: + application/json: + schema: + 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: {} + /api/v1/groups/{inum}/members/{minum}: + post: + summary: Add group member + description: Add group member + operationId: addGroupMember parameters: - name: inum in: path @@ -878,41 +913,6 @@ paths: type: string 500: description: Server error - /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 /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,6 +1009,23 @@ paths: 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 + content: + application/json: + schema: + $ref: '#/components/schemas/ConnectionStatusDTO' /api/v1/configuration/ldap/{name}/status: get: summary: Check the status of an existing configuration @@ -1433,26 +1433,6 @@ 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 @@ -1503,6 +1483,26 @@ 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 @@ -1697,6 +1697,31 @@ paths: type: string 500: description: Server error + /api/v1/sectoridentifiers/search: + get: + summary: Search sector identifiers + description: Search sectors identifiers + operationId: searchSectorIdentifier + parameters: + - name: pattern + in: query + schema: + type: string + - name: size + in: query + schema: + type: integer + format: int32 + default: 10 + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error /api/v1/sectoridentifiers: get: summary: Get all sector identifiers @@ -1747,13 +1772,13 @@ 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 + /api/v1/sectoridentifiers/{inum}: + delete: + summary: Delete sector identifier + description: Delete a sector identifier + operationId: deleteSectorIdentifier parameters: - - name: id + - name: inum in: path required: true schema: @@ -1761,51 +1786,26 @@ paths: responses: 200: description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/OxAuthSectorIdentifier' 500: description: Server error - /api/v1/sectoridentifiers/search: + /api/v1/sectoridentifiers/sector/{id}: get: - summary: Search sector identifiers - description: Search sectors identifiers - operationId: searchSectorIdentifier + summary: Get sector identifier + description: Get a sector identifier + operationId: getSectorIdentifierById parameters: - - name: pattern - in: query + - name: id + in: path + required: true schema: type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 10 responses: 200: description: Success content: application/json: schema: - type: string - 500: - description: Server error - /api/v1/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 + $ref: '#/components/schemas/OxAuthSectorIdentifier' 500: description: Server error /api/v1/configuration/status: @@ -2016,36 +2016,6 @@ paths: description: OK 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/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/set_metadata/{inum}: post: operationId: setMetadata @@ -2082,36 +2052,27 @@ paths: description: default response content: text/plain: {} - /api/v1/saml/tr/set_certificate/{inum}: - post: - summary: set certificate for TrustRelationship - description: Find TrustRelationship by inum and set certificate. - operationId: setCertificate + /api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}: + get: + operationId: listDeconstructedTrustRelationships parameters: - name: inum in: path required: true schema: type: string - requestBody: - content: - text/plain: - schema: - type: string responses: 200: description: OK + content: + application/json: + schema: + 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 @@ -2121,9 +2082,11 @@ paths: 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 @@ -2135,15 +2098,20 @@ paths: text/plain: schema: type: string - required: true responses: 200: description: OK 500: description: Server error - /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 @@ -2153,23 +2121,34 @@ paths: 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 + /api/v1/saml/tr/search_trust_relationships: + get: + operationId: searchTrustRelationships parameters: - - name: inum - in: path + - name: pattern + in: query required: true schema: type: string - requestBody: - content: - application/json: - 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_configuration_files: + put: + summary: generate configuration files + description: Generate configuration files for Shibboleth IDP + operationId: generateConfigurationFiles responses: 200: description: OK @@ -2193,16 +2172,6 @@ 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 - responses: - 200: - description: OK - 500: - description: Server error /api/v1/saml/tr/list_all_active_trust_relationships: get: operationId: listAllActiveTrustRelationships @@ -2215,38 +2184,47 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/list_all_saml_trust_relationships: - get: - operationId: listAllSAMLTrustRelationships + /api/v1/saml/tr/set_metadata_url/{inum}: + post: + operationId: setMetadataURL parameters: - - name: size_limit - in: query + - name: inum + in: path + required: true schema: - type: integer - format: int32 + type: string + requestBody: + content: + text/plain: + schema: + type: string + required: true responses: 200: description: OK - content: - application/json: - schema: - type: string 500: description: Server error - /api/v1/saml/tr/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: + text/plain: + schema: + type: string + 500: + description: Server error + /api/v1/saml/tr/list_all_federations: + get: + operationId: listAllFederations responses: 200: description: OK @@ -2256,6 +2234,28 @@ paths: 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/inbound-saml/trusted-idp/{remoteIdpHost}: get: summary: Get TrustedIDP by remote idp host @@ -2375,45 +2375,24 @@ paths: description: Resource not Found 500: description: Server error - /api/v1/uma/resources/search: - get: - summary: Search UMA resources - description: Search uma resources - operationId: searchUmaResources + /api/v1/uma/resources/{id}/clients/{inum}: + post: + summary: Add UMA resource client + description: add client to uma resource + operationId: addClientToUmaResource parameters: - - name: pattern - in: query + - name: id + in: path 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 - description: Get a uma resource by id - operationId: getUmaResourceById - parameters: - - name: id + - name: inum in: path required: true schema: type: string responses: - 200: + 201: description: Success content: application/json: @@ -2422,61 +2401,20 @@ paths: 500: description: Server error 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 required: true schema: type: string - responses: - 200: - description: Success - 500: - description: Server error - /api/v1/uma/resources: - get: - summary: Get UMA resources - description: Get uma resources - operationId: listUmaResources - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error - put: - summary: Update UMA resource - description: Update uma resource - operationId: updateUmaResource - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' - 500: - description: Server error - post: - summary: Add new UMA resource - description: Add new uma resource - operationId: createUmaResource - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' + - name: inum + in: path + required: true + schema: + type: string responses: 200: description: Success @@ -2551,24 +2489,47 @@ paths: 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 + /api/v1/uma/resources/{id}/clients: + get: + summary: Get clients of UMA resources + description: Get clients of uma resource + operationId: getUmaResourceClients parameters: - name: id in: path required: true schema: type: string - - name: inum - in: path - required: true - schema: - type: string responses: - 201: + default: + description: default response + content: + application/json: {} + /api/v1/uma/resources: + get: + summary: Get UMA resources + description: Get uma resources + operationId: listUmaResources + responses: + 200: + description: Success + content: + application/json: + schema: + type: string + 500: + description: Server error + put: + summary: Update UMA resource + description: Update uma resource + operationId: updateUmaResource + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' + responses: + 200: description: Success content: application/json: @@ -2576,21 +2537,35 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error - delete: - summary: Remove UMA resource client - description: Remove client from uma resource - operationId: removeClientToUmaResource + post: + summary: Add new UMA resource + description: Add new uma resource + operationId: createUmaResource + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' + 500: + description: Server error + /api/v1/uma/resources/{id}: + get: + 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 @@ -2600,11 +2575,10 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error - /api/v1/uma/resources/{id}/clients: - get: - summary: Get clients of UMA resources - description: Get clients of uma resource - operationId: getUmaResourceClients + delete: + summary: Delete UMA resource + description: Delete a uma resource + operationId: deleteUmaResource parameters: - name: id in: path @@ -2612,10 +2586,36 @@ paths: schema: type: string responses: - default: - description: default response + 200: + description: Success + 500: + description: Server error + /api/v1/uma/resources/search: + get: + summary: Search UMA resources + description: Search uma resources + operationId: searchUmaResources + parameters: + - name: pattern + in: query + required: true + schema: + type: string + - name: size + in: query + required: true + schema: + type: integer + format: int32 + responses: + 200: + description: Success content: - application/json: {} + application/json: + schema: + type: string + 500: + description: Server error /api/v1/uma/scopes/{inum}: get: summary: Get UMA scope by inum @@ -2714,13 +2714,56 @@ paths: type: string responses: 200: - description: success + description: success + content: + application/json: + schema: + type: string + 500: + description: Server error + /api/v1/radius/clients/{inum}: + get: + summary: Get radius client by inum + description: Get radius client by inum + operationId: getRadiusClient + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success content: application/json: schema: - type: string + $ref: '#/components/schemas/RadiusClient' + 403: + description: Gluu Radius is not installed + 404: + description: Radius client not found 500: - description: Server error + description: Internal server error + delete: + summary: Delete radius client + description: Deletes a radius client + operationId: deleteRadiusClient + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 204: + description: Success + 403: + description: Gluu Radius is not installed + 404: + description: Radius client not found + 500: + description: Internal server error /api/v1/radius/clients: get: summary: Get all radius clients @@ -2783,49 +2826,6 @@ paths: description: Gluu Radius is not installed 500: description: Internal server error - /api/v1/radius/clients/{inum}: - get: - summary: Get radius client by inum - description: Get radius client by inum - operationId: getRadiusClient - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/RadiusClient' - 403: - description: Gluu Radius is not installed - 404: - description: Radius client not found - 500: - description: Internal server error - delete: - summary: Delete radius client - description: Deletes a radius client - operationId: deleteRadiusClient - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 204: - description: Success - 403: - description: Gluu Radius is not installed - 404: - description: Radius client not found - 500: - description: Internal server error /api/v1/radius/settings: get: summary: Get Radius Server Configuration @@ -2998,18 +2998,18 @@ components: $ref: '#/components/schemas/AttributeValidation' gluuTooltip: type: string - adminCanAccess: - type: boolean - adminCanView: - type: boolean adminCanEdit: type: boolean userCanEdit: type: boolean - userCanView: - type: boolean userCanAccess: type: boolean + adminCanAccess: + type: boolean + adminCanView: + type: boolean + userCanView: + type: boolean whitePagesCanView: type: boolean baseDn: @@ -3108,67 +3108,6 @@ components: type: string name: type: string - Scope: - type: object - properties: - dn: - type: string - expirationDate: - type: string - format: date-time - deletable: - type: boolean - inum: - type: string - displayName: - type: string - id: - type: string - iconUrl: - type: string - description: - type: string - scopeType: - type: string - enum: - - openid - - dynamic - - uma - - spontaneous - - oauth - oxAuthClaims: - type: array - items: - type: string - defaultScope: - type: boolean - oxAuthGroupClaims: - type: boolean - dynamicScopeScripts: - type: array - items: - type: string - umaAuthorizationPolicies: - type: array - items: - type: string - attributes: - $ref: '#/components/schemas/ScopeAttributes' - umaType: - type: boolean - baseDn: - type: string - ScopeAttributes: - type: object - properties: - spontaneousClientId: - type: string - spontaneousClientScopes: - type: array - items: - type: string - showInConfigurationEndpoint: - type: boolean ClientAttributes: type: object properties: @@ -3529,6 +3468,67 @@ components: type: boolean baseDn: type: string + Scope: + type: object + properties: + dn: + type: string + expirationDate: + type: string + format: date-time + deletable: + type: boolean + inum: + type: string + displayName: + type: string + id: + type: string + iconUrl: + type: string + description: + type: string + scopeType: + type: string + enum: + - openid + - dynamic + - uma + - spontaneous + - oauth + oxAuthClaims: + type: array + items: + type: string + defaultScope: + type: boolean + oxAuthGroupClaims: + type: boolean + dynamicScopeScripts: + type: array + items: + type: string + umaAuthorizationPolicies: + type: array + items: + type: string + attributes: + $ref: '#/components/schemas/ScopeAttributes' + umaType: + type: boolean + baseDn: + type: string + ScopeAttributes: + type: object + properties: + spontaneousClientId: + type: string + spontaneousClientScopes: + type: array + items: + type: string + showInConfigurationEndpoint: + type: boolean CacheConfiguration: type: object properties: @@ -4031,13 +4031,13 @@ components: type: boolean internal: type: boolean + locationPath: + type: string locationType: type: string enum: - ldap - file - locationPath: - type: string baseDn: type: string ScriptError: @@ -5265,28 +5265,28 @@ components: - "true" - inactive - active - stringValues: - type: array - items: - type: string - stringValue: - type: string - adminCanAccess: + multiValued: type: boolean - adminCanView: + new: type: boolean adminCanEdit: type: boolean userCanEdit: type: boolean - userCanView: - type: boolean userCanAccess: type: boolean - multiValued: + adminCanAccess: type: boolean - new: + adminCanView: type: boolean + userCanView: + type: boolean + stringValues: + type: array + items: + type: string + stringValue: + type: string GluuSAMLTrustRelationship: required: - description @@ -5399,22 +5399,22 @@ components: type: string certificate: type: string - specificRelyingPartyConfig: - type: boolean - containerFederation: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' - researchBundle: - type: boolean - entityId: - type: string - federation: - type: boolean uniqueGluuEntityId: uniqueItems: true type: array writeOnly: true items: type: string + entityId: + type: string + federation: + type: boolean + researchBundle: + type: boolean + specificRelyingPartyConfig: + type: boolean + containerFederation: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' baseDn: type: string writeOnly: true