From 775ecdd177f6648b567d2e81ee5b20d08f2f6f4b Mon Sep 17 00:00:00 2001 From: shekhar16 Date: Fri, 24 Nov 2023 01:50:29 +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 | 2338 ++++++++--------- .../src/main/resources/META-INF/openapi.yaml | 1614 ++++++------ 3 files changed, 1980 insertions(+), 1980 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..8d31e16ef 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.2", 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 cbab0777c..68b280070 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.2" }, "paths" : { "/configuration/api" : { @@ -173,18 +173,34 @@ } } }, - "/api/v1/attributes/inactive" : { + "/api/v1/attributes/search" : { "get" : { - "summary" : "Get all inactive attributes", - "description" : "Gets all inative attributes", - "operationId" : "getAllInactiveAttributes", + "summary" : "Search attributes", + "description" : "Perform an attribute search", + "operationId" : "searchAttributes", + "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" + "$ref" : "#/components/schemas/GluuAttribute" } } } @@ -198,18 +214,26 @@ } ] } }, - "/api/v1/attributes/active" : { + "/api/v1/attributes/attribute/{inum}" : { "get" : { - "summary" : "Get all active attributes", - "description" : "Gets all the active gluu attributes", - "operationId" : "getAllActiveAttributes", + "summary" : "Get attribute by inum", + "description" : "Get an attribute by inum", + "operationId" : "getAttributeByInum", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], "responses" : { "200" : { "description" : "success", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/GluuAttribute" } } } @@ -252,34 +276,18 @@ } ] } }, - "/api/v1/attributes/search" : { + "/api/v1/attributes/active" : { "get" : { - "summary" : "Search attributes", - "description" : "Perform an attribute search", - "operationId" : "searchAttributes", - "parameters" : [ { - "name" : "pattern", - "in" : "query", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "size", - "in" : "query", - "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 1 - } - } ], + "summary" : "Get all active attributes", + "description" : "Gets all the active gluu attributes", + "operationId" : "getAllActiveAttributes", "responses" : { "200" : { "description" : "success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuAttribute" + "type" : "string" } } } @@ -293,26 +301,18 @@ } ] } }, - "/api/v1/attributes/attribute/{inum}" : { + "/api/v1/attributes/inactive" : { "get" : { - "summary" : "Get attribute by inum", - "description" : "Get an attribute by inum", - "operationId" : "getAttributeByInum", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "summary" : "Get all inactive attributes", + "description" : "Gets all inative attributes", + "operationId" : "getAllInactiveAttributes", "responses" : { "200" : { "description" : "success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuAttribute" + "type" : "string" } } } @@ -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,11 +749,11 @@ } ] } }, - "/api/v1/clients/{inum}/scopes/{sinum}" : { - "post" : { - "summary" : "Add OIDC client scopes", - "description" : "Add scopes to OIDC client", - "operationId" : "addScopeToClient", + "/api/v1/clients/{inum}" : { + "get" : { + "summary" : "Get OIDC client", + "description" : "Get a specific OIDC client", + "operationId" : "getClientByInum", "parameters" : [ { "name" : "inum", "in" : "path", @@ -747,13 +761,6 @@ "schema" : { "type" : "string" } - }, { - "name" : "sinum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { @@ -761,7 +768,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/OxAuthClient" } } } @@ -771,13 +778,13 @@ } }, "security" : [ { - "oauth2" : [ "https://gluu.org/auth/oxtrust.client.write" ] + "oauth2" : [ "https://gluu.org/auth/oxtrust.client.read" ] } ] }, "delete" : { - "summary" : "Remove OIDC client scope", - "description" : "Remove an existing scope from client", - "operationId" : "removeScopeToClient", + "summary" : "Delete OIDC client ", + "description" : "Delete an openidconnect client", + "operationId" : "deleteClient", "parameters" : [ { "name" : "inum", "in" : "path", @@ -785,13 +792,6 @@ "schema" : { "type" : "string" } - }, { - "name" : "sinum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { @@ -1049,18 +1049,25 @@ } ] } }, - "/api/v1/groups" : { + "/api/v1/groups/search" : { "get" : { - "summary" : "Get groups", - "description" : "Get groups", - "operationId" : "listGroups", + "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" : 0 + "default" : 1 } } ], "responses" : { @@ -1078,85 +1085,26 @@ "description" : "Server error" } } - }, - "put" : { - "summary" : "Update group", - "description" : "Update a group", - "operationId" : "updateGroup", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GluuGroupApi" - } - } - } - }, - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GluuGroupApi" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } - }, - "post" : { - "summary" : "Add group", - "description" : "Add a group", - "operationId" : "createGroup", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GluuGroupApi" - } - } - } - }, - "responses" : { - "201" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/GluuGroupApi" - } - } - } - }, - "500" : { - "description" : "Server error" - } - } } }, - "/api/v1/groups/search" : { - "get" : { - "summary" : "Search groups", - "description" : "Search groups", - "operationId" : "searchGroups", + "/api/v1/groups/{inum}/members/{minum}" : { + "post" : { + "summary" : "Add group member", + "description" : "Add group member", + "operationId" : "addGroupMember", "parameters" : [ { - "name" : "pattern", - "in" : "query", + "name" : "inum", + "in" : "path", "required" : true, "schema" : { "type" : "string" } }, { - "name" : "size", - "in" : "query", + "name" : "minum", + "in" : "path", + "required" : true, "schema" : { - "type" : "integer", - "format" : "int32", - "default" : 1 + "type" : "string" } } ], "responses" : { @@ -1174,13 +1122,11 @@ "description" : "Server error" } } - } - }, - "/api/v1/groups/{inum}" : { - "get" : { - "summary" : "Get group by inum", - "description" : "Get a group by inum", - "operationId" : "getGroupByInum", + }, + "delete" : { + "summary" : "Remove group member", + "description" : "Remove a member from group", + "operationId" : "removeGroupMember", "parameters" : [ { "name" : "inum", "in" : "path", @@ -1188,29 +1134,8 @@ "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", + }, { + "name" : "minum", "in" : "path", "required" : true, "schema" : { @@ -1278,24 +1203,18 @@ } } }, - "/api/v1/groups/{inum}/members/{minum}" : { - "post" : { - "summary" : "Add group member", - "description" : "Add group member", - "operationId" : "addGroupMember", + "/api/v1/groups" : { + "get" : { + "summary" : "Get groups", + "description" : "Get groups", + "operationId" : "listGroups", "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - }, { - "name" : "minum", - "in" : "path", - "required" : true, + "name" : "size", + "in" : "query", "schema" : { - "type" : "string" + "type" : "integer", + "format" : "int32", + "default" : 0 } } ], "responses" : { @@ -1314,10 +1233,70 @@ } } }, - "delete" : { - "summary" : "Remove group member", - "description" : "Remove a member from group", - "operationId" : "removeGroupMember", + "put" : { + "summary" : "Update group", + "description" : "Update a group", + "operationId" : "updateGroup", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuGroupApi" + } + } + } + }, + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuGroupApi" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + }, + "post" : { + "summary" : "Add group", + "description" : "Add a group", + "operationId" : "createGroup", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuGroupApi" + } + } + } + }, + "responses" : { + "201" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/GluuGroupApi" + } + } + } + }, + "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", @@ -1325,8 +1304,29 @@ "schema" : { "type" : "string" } - }, { - "name" : "minum", + } ], + "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" : { @@ -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", @@ -2372,18 +2372,26 @@ } } }, - "/api/v1/scopes" : { + "/api/v1/scopes/{inum}" : { "get" : { - "summary" : "Get all scopes", - "description" : "Get all scopes", - "operationId" : "getAllScopes", + "summary" : "Get openid scope", + "description" : "Get a specific openid connect scope", + "operationId" : "getScopeByInum", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/Scope" } } } @@ -2393,22 +2401,65 @@ } } }, - "put" : { - "summary" : "Update openid connect scope", - "description" : "Update openidconect scope", - "operationId" : "updateScope", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/Scope" - } - } + "delete" : { + "summary" : "Delete openid connect scope", + "description" : "Delete an openidconnect scope", + "operationId" : "deleteScope", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" } - }, + } ], "responses" : { "200" : { - "description" : "Success", + "description" : "Success" + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/scopes" : { + "get" : { + "summary" : "Get all scopes", + "description" : "Get all scopes", + "operationId" : "getAllScopes", + "responses" : { + "200" : { + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + }, + "put" : { + "summary" : "Update openid connect scope", + "description" : "Update openidconect scope", + "operationId" : "updateScope", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/Scope" + } + } + } + }, + "responses" : { + "200" : { + "description" : "Success", "content" : { "application/json" : { "schema" : { @@ -2452,11 +2503,11 @@ } } }, - "/api/v1/scopes/{inum}" : { + "/api/v1/scopes/{inum}/claims" : { "get" : { - "summary" : "Get openid scope", - "description" : "Get a specific openid connect scope", - "operationId" : "getScopeByInum", + "summary" : "Get scope claims", + "description" : "List all claims of a scope", + "operationId" : "getScopeClaims", "parameters" : [ { "name" : "inum", "in" : "path", @@ -2471,7 +2522,7 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/Scope" + "type" : "string" } } } @@ -2480,22 +2531,38 @@ "description" : "Server error" } } - }, - "delete" : { - "summary" : "Delete openid connect scope", - "description" : "Delete an openidconnect scope", - "operationId" : "deleteScope", + } + }, + "/api/v1/scopes/search" : { + "get" : { + "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" + "description" : "Success", + "content" : { + "application/json" : { + "schema" : { + "type" : "string" + } + } + } }, "500" : { "description" : "Server error" @@ -2503,13 +2570,13 @@ } } }, - "/api/v1/scopes/{inum}/claims" : { + "/api/v1/sectoridentifiers/sector/{id}" : { "get" : { - "summary" : "Get scope claims", - "description" : "List all claims of a scope", - "operationId" : "getScopeClaims", + "summary" : "Get sector identifier", + "description" : "Get a sector identifier", + "operationId" : "getSectorIdentifierById", "parameters" : [ { - "name" : "inum", + "name" : "id", "in" : "path", "required" : true, "schema" : { @@ -2522,7 +2589,7 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/OxAuthSectorIdentifier" } } } @@ -2533,11 +2600,34 @@ } } }, - "/api/v1/scopes/search" : { + "/api/v1/sectoridentifiers/{inum}" : { + "delete" : { + "summary" : "Delete sector identifier", + "description" : "Delete a sector identifier", + "operationId" : "deleteSectorIdentifier", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "Success" + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/sectoridentifiers/search" : { "get" : { - "summary" : "Search openid connect scopes", - "description" : "Search openid connect scopes", - "operationId" : "searchScope", + "summary" : "Search sector identifiers", + "description" : "Search sectors identifiers", + "operationId" : "searchSectorIdentifier", "parameters" : [ { "name" : "pattern", "in" : "query", @@ -2650,26 +2740,18 @@ } } }, - "/api/v1/sectoridentifiers/sector/{id}" : { + "/api/v1/configuration/status" : { "get" : { - "summary" : "Get sector identifier", - "description" : "Get a sector identifier", - "operationId" : "getSectorIdentifierById", - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], + "summary" : "Get server status", + "description" : "Get server status", + "operationId" : "getServerStatus", "responses" : { "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/OxAuthSectorIdentifier" + "$ref" : "#/components/schemas/GluuServerStatus" } } } @@ -2680,33 +2762,18 @@ } } }, - "/api/v1/sectoridentifiers/search" : { + "/api/v1/configuration/smtp" : { "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 - } - } ], + "summary" : "Get smtp configuration", + "description" : "Get smtp configuration", + "operationId" : "getSmtpServerConfiguration", "responses" : { "200" : { - "description" : "Success", + "description" : "success", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/SmtpConfiguration" } } } @@ -2715,47 +2782,34 @@ "description" : "Server error" } } - } - }, - "/api/v1/sectoridentifiers/{inum}" : { - "delete" : { - "summary" : "Delete sector identifier", - "description" : "Delete a sector identifier", - "operationId" : "deleteSectorIdentifier", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Success" - }, - "500" : { - "description" : "Server error" + }, + "put" : { + "summary" : "Update smtp configuration", + "description" : "Update smtp configuration", + "operationId" : "updateSmtpConfiguration", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/SmtpConfiguration" + } + } } - } - } - }, - "/api/v1/configuration/status" : { - "get" : { - "summary" : "Get server status", - "description" : "Get server status", - "operationId" : "getServerStatus", + }, "responses" : { "200" : { - "description" : "Success", + "description" : "success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/GluuServerStatus" + "$ref" : "#/components/schemas/SmtpConfiguration" } } } }, + "404" : { + "description" : "Not found" + }, "500" : { "description" : "Server error" } @@ -2784,18 +2838,18 @@ } } }, - "/api/v1/configuration/smtp" : { + "/configuration/system" : { "get" : { - "summary" : "Get smtp configuration", - "description" : "Get smtp configuration", - "operationId" : "getSmtpServerConfiguration", + "summary" : "Retrieve system configuration", + "description" : "Retrieve system configuration", + "operationId" : "retrieveSystemConfiguration", "responses" : { "200" : { "description" : "success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/SmtpConfiguration" + "$ref" : "#/components/schemas/SystemConfig" } } } @@ -2806,14 +2860,14 @@ } }, "put" : { - "summary" : "Update smtp configuration", - "description" : "Update smtp configuration", - "operationId" : "updateSmtpConfiguration", + "summary" : "Update system configuration", + "description" : "Update system configuration", + "operationId" : "updateSystemConfiguration", "requestBody" : { "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/SmtpConfiguration" + "$ref" : "#/components/schemas/SystemConfig" } } } @@ -2824,32 +2878,35 @@ "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/SmtpConfiguration" + "$ref" : "#/components/schemas/SystemConfig" } } } }, - "404" : { - "description" : "Not found" - }, "500" : { "description" : "Server error" } } } }, - "/configuration/system" : { + "/api/v1/saml/tr/get_contacts/{inum}" : { "get" : { - "summary" : "Retrieve system configuration", - "description" : "Retrieve system configuration", - "operationId" : "retrieveSystemConfiguration", - "responses" : { - "200" : { - "description" : "success", + "operationId" : "getContacts", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "responses" : { + "200" : { + "description" : "OK", "content" : { - "application/json" : { + "text/plain" : { "schema" : { - "$ref" : "#/components/schemas/SystemConfig" + "type" : "string" } } } @@ -2858,27 +2915,161 @@ "description" : "Server error" } } - }, - "put" : { - "summary" : "Update system configuration", - "description" : "Update system configuration", - "operationId" : "updateSystemConfiguration", + } + }, + "/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" : { - "$ref" : "#/components/schemas/SystemConfig" + "type" : "string" } } } }, "responses" : { "200" : { - "description" : "success", + "description" : "OK" + }, + "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/list_all_federations" : { + "get" : { + "operationId" : "listAllFederations", + "responses" : { + "200" : { + "description" : "OK", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/SystemConfig" + "type" : "string" + } + } + } + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/saml/tr/set_certificate/{inum}" : { + "post" : { + "summary" : "set certificate for TrustRelationship", + "description" : "Find TrustRelationship by inum and set certificate.", + "operationId" : "setCertificate", + "parameters" : [ { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } + } ], + "requestBody" : { + "content" : { + "text/plain" : { + "schema" : { + "type" : "string" + } + } + } + }, + "responses" : { + "200" : { + "description" : "OK" + }, + "500" : { + "description" : "Server error" + } + } + } + }, + "/api/v1/saml/tr/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" } } } @@ -3065,6 +3256,28 @@ } } }, + "/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", @@ -3101,31 +3314,39 @@ } } }, - "/api/v1/saml/tr/remove_attribute" : { - "delete" : { - "operationId" : "removeAttribute", - "requestBody" : { - "content" : { - "text/plain" : { - "schema" : { - "$ref" : "#/components/schemas/GluuAttribute" - } - } - } - }, + "/api/v1/saml/tr/generate_configuration_files" : { + "put" : { + "summary" : "generate configuration files", + "description" : "Generate configuration files for Shibboleth IDP", + "operationId" : "generateConfigurationFiles", "responses" : { - "default" : { - "description" : "default response", - "content" : { - "text/plain" : { } - } + "200" : { + "description" : "OK" + }, + "500" : { + "description" : "Server error" } } } }, - "/api/v1/saml/tr/list_all_federations" : { + "/api/v1/saml/tr/search_trust_relationships" : { "get" : { - "operationId" : "listAllFederations", + "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", @@ -3143,85 +3364,22 @@ } } }, - "/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/list_all_saml_trust_relationships" : { + "get" : { + "operationId" : "listAllSAMLTrustRelationships", "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, + "name" : "size_limit", + "in" : "query", "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "type" : "string" - } - } - } - }, - "responses" : { - "200" : { - "description" : "OK" - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/saml/tr/set_metadata_url/{inum}" : { - "post" : { - "operationId" : "setMetadataURL", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "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/get_contacts/{inum}" : { - "get" : { - "operationId" : "getContacts", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" + "type" : "integer", + "format" : "int32" } } ], "responses" : { "200" : { "description" : "OK", "content" : { - "text/plain" : { + "application/json" : { "schema" : { "type" : "string" } @@ -3234,38 +3392,6 @@ } } }, - "/api/v1/saml/tr/set_certificate/{inum}" : { - "post" : { - "summary" : "set certificate for TrustRelationship", - "description" : "Find TrustRelationship by inum and set certificate.", - "operationId" : "setCertificate", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "requestBody" : { - "content" : { - "text/plain" : { - "schema" : { - "type" : "string" - } - } - } - }, - "responses" : { - "200" : { - "description" : "OK" - }, - "500" : { - "description" : "Server error" - } - } - } - }, "/api/v1/saml/tr/list_all_other_federations/{inum}" : { "get" : { "operationId" : "listAllOtherFederations", @@ -3294,69 +3420,6 @@ } } }, - "/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" : { - "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/list_all_active_trust_relationships" : { "get" : { "operationId" : "listAllActiveTrustRelationships", @@ -3377,69 +3440,6 @@ } } }, - "/api/v1/saml/tr/generate_configuration_files" : { - "put" : { - "summary" : "generate configuration files", - "description" : "Generate configuration files for Shibboleth IDP", - "operationId" : "generateConfigurationFiles", - "responses" : { - "200" : { - "description" : "OK" - }, - "500" : { - "description" : "Server error" - } - } - } - }, - "/api/v1/saml/tr/list_deconstructed_trust_relationships/{inum}" : { - "get" : { - "operationId" : "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/inbound-saml/trusted-idp" : { "get" : { "summary" : "Retrieve all trusted-idps", @@ -3494,39 +3494,6 @@ } } }, - "/api/v1/inbound-saml/trusted-idp/inum/{inum}" : { - "get" : { - "summary" : "Get TrustedIDP by inum", - "description" : "Get a TrustedIDP by inum", - "operationId" : "gluuTrustedIdp", - "parameters" : [ { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } - } ], - "responses" : { - "200" : { - "description" : "Success", - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/TrustedIDPApi" - } - } - } - }, - "404" : { - "description" : "Resource not Found" - }, - "500" : { - "description" : "Server error" - } - } - } - }, "/api/v1/inbound-saml/trusted-idp/{remoteIdpHost}" : { "get" : { "summary" : "Get TrustedIDP by remote idp host", @@ -3621,26 +3588,18 @@ } } }, - "/api/v1/uma/resources/search" : { + "/api/v1/inbound-saml/trusted-idp/inum/{inum}" : { "get" : { - "summary" : "Search UMA resources", - "description" : "Search uma resources", - "operationId" : "searchUmaResources", - "parameters" : [ { - "name" : "pattern", - "in" : "query", + "summary" : "Get TrustedIDP by inum", + "description" : "Get a TrustedIDP by inum", + "operationId" : "gluuTrustedIdp", + "parameters" : [ { + "name" : "inum", + "in" : "path", "required" : true, "schema" : { "type" : "string" } - }, { - "name" : "size", - "in" : "query", - "required" : true, - "schema" : { - "type" : "integer", - "format" : "int32" - } } ], "responses" : { "200" : { @@ -3648,29 +3607,47 @@ "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/TrustedIDPApi" } } } }, + "404" : { + "description" : "Resource not Found" + }, "500" : { "description" : "Server error" } } } }, - "/api/v1/uma/resources" : { - "get" : { - "summary" : "Get UMA resources", - "description" : "Get uma resources", - "operationId" : "listUmaResources", + "/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" : { - "200" : { + "201" : { "description" : "Success", "content" : { "application/json" : { "schema" : { - "type" : "string" + "$ref" : "#/components/schemas/UmaResource" } } } @@ -3680,19 +3657,25 @@ } } }, - "put" : { - "summary" : "Update UMA resource", - "description" : "Update uma resource", - "operationId" : "updateUmaResource", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UmaResource" - } - } + "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", @@ -3708,20 +3691,28 @@ "description" : "Server error" } } - }, + } + }, + "/api/v1/uma/resources/{id}/scopes/{inum}" : { "post" : { - "summary" : "Add new UMA resource", - "description" : "Add new uma resource", - "operationId" : "createUmaResource", - "requestBody" : { - "content" : { - "application/json" : { - "schema" : { - "$ref" : "#/components/schemas/UmaResource" - } - } + "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", @@ -3737,13 +3728,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 scope", + "description" : "remove a scope from uma resource", + "operationId" : "removeScopeToUmaResource", "parameters" : [ { "name" : "id", "in" : "path", @@ -3751,6 +3740,13 @@ "schema" : { "type" : "string" } + }, { + "name" : "inum", + "in" : "path", + "required" : true, + "schema" : { + "type" : "string" + } } ], "responses" : { "200" : { @@ -3767,11 +3763,13 @@ "description" : "Server error" } } - }, - "delete" : { - "summary" : "Delete UMA resource", - "description" : "Delete a uma resource", - "operationId" : "deleteUmaResource", + } + }, + "/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", @@ -3781,11 +3779,11 @@ } } ], "responses" : { - "200" : { - "description" : "Success" - }, - "500" : { - "description" : "Server error" + "default" : { + "description" : "default response", + "content" : { + "application/json" : { } + } } } } @@ -3813,33 +3811,34 @@ } } }, - "/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/search" : { + "get" : { + "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" : { - "201" : { + "200" : { "description" : "Success", "content" : { "application/json" : { "schema" : { - "$ref" : "#/components/schemas/UmaResource" + "type" : "string" } } } @@ -3848,26 +3847,42 @@ "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" + } + }, + "/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" } - }, { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" + } + }, + "put" : { + "summary" : "Update UMA resource", + "description" : "Update uma resource", + "operationId" : "updateUmaResource", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UmaResource" + } + } } - } ], + }, "responses" : { "200" : { "description" : "Success", @@ -3883,36 +3898,42 @@ "description" : "Server error" } } - } - }, - "/api/v1/uma/resources/{id}/clients" : { - "get" : { - "summary" : "Get clients of UMA resources", - "description" : "Get clients of uma resource", - "operationId" : "getUmaResourceClients", - "parameters" : [ { - "name" : "id", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" + }, + "post" : { + "summary" : "Add new UMA resource", + "description" : "Add new uma resource", + "operationId" : "createUmaResource", + "requestBody" : { + "content" : { + "application/json" : { + "schema" : { + "$ref" : "#/components/schemas/UmaResource" + } + } } - } ], + }, "responses" : { - "default" : { - "description" : "default response", + "200" : { + "description" : "Success", "content" : { - "application/json" : { } + "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", + "/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", @@ -3920,13 +3941,6 @@ "schema" : { "type" : "string" } - }, { - "name" : "inum", - "in" : "path", - "required" : true, - "schema" : { - "type" : "string" - } } ], "responses" : { "200" : { @@ -3945,9 +3959,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", @@ -3955,24 +3969,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" @@ -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", @@ -4239,69 +4302,6 @@ } } }, - "/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", @@ -4514,22 +4514,22 @@ "gluuTooltip" : { "type" : "string" }, - "adminCanAccess" : { + "userCanAccess" : { "type" : "boolean" }, - "userCanView" : { + "adminCanEdit" : { "type" : "boolean" }, - "adminCanEdit" : { + "userCanView" : { "type" : "boolean" }, - "userCanAccess" : { + "adminCanView" : { "type" : "boolean" }, "userCanEdit" : { "type" : "boolean" }, - "adminCanView" : { + "adminCanAccess" : { "type" : "boolean" }, "whitePagesCanView" : { @@ -4622,54 +4622,138 @@ "$ref" : "#/components/schemas/X509CertificateShortInfo" } }, - "trustStoreCertificates" : { + "trustStoreCertificates" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/X509CertificateShortInfo" + } + }, + "internalCertificates" : { + "type" : "array", + "items" : { + "$ref" : "#/components/schemas/X509CertificateShortInfo" + } + } + } + }, + "X509CertificateShortInfo" : { + "type" : "object", + "properties" : { + "alias" : { + "type" : "string" + }, + "issuer" : { + "type" : "string" + }, + "subject" : { + "type" : "string" + }, + "algorithm" : { + "type" : "string" + }, + "notBeforeDatetime" : { + "type" : "string", + "format" : "date-time" + }, + "notAfterDatetime" : { + "type" : "string", + "format" : "date-time" + }, + "viewStyle" : { + "type" : "string" + }, + "warning" : { + "type" : "boolean" + }, + "path" : { + "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" : { - "$ref" : "#/components/schemas/X509CertificateShortInfo" + "type" : "string" } }, - "internalCertificates" : { + "umaAuthorizationPolicies" : { "type" : "array", "items" : { - "$ref" : "#/components/schemas/X509CertificateShortInfo" + "type" : "string" } + }, + "attributes" : { + "$ref" : "#/components/schemas/ScopeAttributes" + }, + "umaType" : { + "type" : "boolean" + }, + "baseDn" : { + "type" : "string" } } }, - "X509CertificateShortInfo" : { + "ScopeAttributes" : { "type" : "object", "properties" : { - "alias" : { - "type" : "string" - }, - "issuer" : { - "type" : "string" - }, - "subject" : { - "type" : "string" - }, - "algorithm" : { + "spontaneousClientId" : { "type" : "string" }, - "notBeforeDatetime" : { - "type" : "string", - "format" : "date-time" - }, - "notAfterDatetime" : { - "type" : "string", - "format" : "date-time" - }, - "viewStyle" : { - "type" : "string" + "spontaneousClientScopes" : { + "type" : "array", + "items" : { + "type" : "string" + } }, - "warning" : { + "showInConfigurationEndpoint" : { "type" : "boolean" - }, - "path" : { - "type" : "string" - }, - "name" : { - "type" : "string" } } }, @@ -5016,90 +5100,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" - } - } - }, "CacheConfiguration" : { "type" : "object", "properties" : { @@ -5578,9 +5578,6 @@ "SmtpConfiguration" : { "type" : "object", "properties" : { - "valid" : { - "type" : "boolean" - }, "connectProtectionList" : { "type" : "array", "items" : { @@ -5588,6 +5585,9 @@ "enum" : [ "None", "StartTls", "SslTls" ] } }, + "valid" : { + "type" : "boolean" + }, "host" : { "type" : "string" }, @@ -5761,13 +5761,13 @@ "internal" : { "type" : "boolean" }, - "locationPath" : { - "type" : "string" - }, "locationType" : { "type" : "string", "enum" : [ "ldap", "file" ] }, + "locationPath" : { + "type" : "string" + }, "baseDn" : { "type" : "string" } @@ -6643,117 +6643,14 @@ "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" - }, - "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" + "loggingLevel" : { + "type" : "string" }, - "enforceEmailUniqueness" : { - "type" : "boolean" + "errorHandlingMethod" : { + "type" : "string" }, - "useLocalCache" : { - "type" : "boolean" + "cookieDomain" : { + "type" : "string" } } }, @@ -7122,6 +7019,109 @@ } } }, + "OxTrustBasicConfig" : { + "type" : "object", + "properties" : { + "baseDN" : { + "type" : "string" + }, + "orgSupportEmail" : { + "type" : "string" + }, + "applicationUrl" : { + "type" : "string" + }, + "baseEndpoint" : { + "type" : "string" + }, + "ldifStore" : { + "type" : "string" + }, + "updateStatus" : { + "type" : "boolean" + }, + "keystorePath" : { + "type" : "string" + }, + "allowPersonModification" : { + "type" : "boolean" + }, + "configGeneration" : { + "type" : "boolean" + }, + "gluuSpCert" : { + "type" : "string" + }, + "certDir" : { + "type" : "string" + }, + "servicesRestartTrigger" : { + "type" : "string" + }, + "loginRedirectUrl" : { + "type" : "string" + }, + "logoutRedirectUrl" : { + "type" : "string" + }, + "clientAssociationAttribute" : { + "type" : "string" + }, + "ignoreValidation" : { + "type" : "boolean" + }, + "umaIssuer" : { + "type" : "string" + }, + "cssLocation" : { + "type" : "string" + }, + "jsLocation" : { + "type" : "string" + }, + "enableUpdateNotification" : { + "type" : "boolean" + }, + "oxIncommonFlag" : { + "type" : "boolean" + }, + "clientWhiteList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "clientBlackList" : { + "type" : "array", + "items" : { + "type" : "string" + } + }, + "loggingLevel" : { + "type" : "string" + }, + "organizationName" : { + "type" : "string" + }, + "disableJdkLogger" : { + "type" : "boolean" + }, + "passwordResetRequestExpirationTime" : { + "type" : "integer", + "format" : "int32" + }, + "cleanServiceInterval" : { + "type" : "integer", + "format" : "int32" + }, + "enforceEmailUniqueness" : { + "type" : "boolean" + }, + "useLocalCache" : { + "type" : "boolean" + } + } + }, "OxTrustJsonSetting" : { "type" : "object", "properties" : { @@ -7513,6 +7513,47 @@ } } }, + "TrustContact" : { + "type" : "object", + "properties" : { + "name" : { + "type" : "string" + }, + "phone" : { + "type" : "string" + }, + "mail" : { + "type" : "string" + }, + "title" : { + "type" : "string" + } + } + }, + "SAMLTrustRelationshipShort" : { + "type" : "object", + "properties" : { + "inum" : { + "type" : "string" + }, + "displayName" : { + "type" : "string" + }, + "description" : { + "type" : "string" + }, + "validationStatus" : { + "type" : "string", + "enum" : [ "In Progress", "Success", "Scheduled", "Failed" ] + }, + "releasedAttributes" : { + "type" : "array", + "items" : { + "type" : "string" + } + } + } + }, "GluuCustomAttribute" : { "type" : "object", "properties" : { @@ -7538,44 +7579,44 @@ "enum" : [ "disabled", "enabled", "false", "true", "inactive", "active" ] } }, - "displayValue" : { + "multiValued" : { + "type" : "boolean" + }, + "value" : { "type" : "object" }, "booleanValue" : { "type" : "string", "enum" : [ "disabled", "enabled", "false", "true", "inactive", "active" ] }, - "adminCanAccess" : { - "type" : "boolean" + "stringValue" : { + "type" : "string" }, - "userCanView" : { - "type" : "boolean" + "stringValues" : { + "type" : "array", + "items" : { + "type" : "string" + } }, - "adminCanEdit" : { + "userCanAccess" : { "type" : "boolean" }, - "userCanAccess" : { + "adminCanEdit" : { "type" : "boolean" }, - "userCanEdit" : { + "userCanView" : { "type" : "boolean" }, "adminCanView" : { "type" : "boolean" }, - "new" : { + "userCanEdit" : { "type" : "boolean" }, - "stringValues" : { - "type" : "array", - "items" : { - "type" : "string" - } - }, - "stringValue" : { - "type" : "string" + "adminCanAccess" : { + "type" : "boolean" }, - "multiValued" : { + "new" : { "type" : "boolean" } } @@ -7714,18 +7755,6 @@ "certificate" : { "type" : "string" }, - "federation" : { - "type" : "boolean" - }, - "entityId" : { - "type" : "string" - }, - "specificRelyingPartyConfig" : { - "type" : "boolean" - }, - "containerFederation" : { - "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" - }, "uniqueGluuEntityId" : { "uniqueItems" : true, "type" : "array", @@ -7734,6 +7763,18 @@ "type" : "string" } }, + "entityId" : { + "type" : "string" + }, + "containerFederation" : { + "$ref" : "#/components/schemas/GluuSAMLTrustRelationship" + }, + "specificRelyingPartyConfig" : { + "type" : "boolean" + }, + "federation" : { + "type" : "boolean" + }, "researchBundle" : { "type" : "boolean" }, @@ -7843,47 +7884,6 @@ } } }, - "SAMLTrustRelationshipShort" : { - "type" : "object", - "properties" : { - "inum" : { - "type" : "string" - }, - "displayName" : { - "type" : "string" - }, - "description" : { - "type" : "string" - }, - "validationStatus" : { - "type" : "string", - "enum" : [ "In Progress", "Success", "Scheduled", "Failed" ] - }, - "releasedAttributes" : { - "type" : "array", - "items" : { - "type" : "string" - } - } - } - }, - "TrustContact" : { - "type" : "object", - "properties" : { - "name" : { - "type" : "string" - }, - "phone" : { - "type" : "string" - }, - "mail" : { - "type" : "string" - }, - "title" : { - "type" : "string" - } - } - }, "RemoteIdp" : { "type" : "object", "properties" : { diff --git a/api-server/src/main/resources/META-INF/openapi.yaml b/api-server/src/main/resources/META-INF/openapi.yaml index 311a279d3..def75438e 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.2 paths: /configuration/api: get: @@ -116,35 +116,53 @@ paths: description: default response content: application/json: {} - /api/v1/attributes/inactive: + /api/v1/attributes/search: get: - summary: Get all inactive attributes - description: Gets all inative attributes - operationId: getAllInactiveAttributes + summary: Search attributes + description: Perform an attribute search + operationId: searchAttributes + 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 + $ref: '#/components/schemas/GluuAttribute' 500: description: Server error security: - oauth2: - https://gluu.org/auth/oxtrust.attribute.read - /api/v1/attributes/active: + /api/v1/attributes/attribute/{inum}: get: - summary: Get all active attributes - description: Gets all the active gluu attributes - operationId: getAllActiveAttributes + summary: Get attribute by inum + description: Get an attribute by inum + operationId: getAttributeByInum + parameters: + - name: inum + in: path + required: true + schema: + type: string responses: 200: description: success content: application/json: schema: - type: string + $ref: '#/components/schemas/GluuAttribute' 500: description: Server error security: @@ -171,53 +189,35 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.attribute.write - /api/v1/attributes/search: + /api/v1/attributes/active: get: - summary: Search attributes - description: Perform an attribute search - operationId: searchAttributes - parameters: - - name: pattern - in: query - required: true - schema: - type: string - - name: size - in: query - schema: - type: integer - format: int32 - default: 1 + summary: Get all active attributes + description: Gets all the active gluu attributes + operationId: getAllActiveAttributes responses: 200: description: success content: application/json: schema: - $ref: '#/components/schemas/GluuAttribute' + type: string 500: description: Server error security: - oauth2: - https://gluu.org/auth/oxtrust.attribute.read - /api/v1/attributes/attribute/{inum}: + /api/v1/attributes/inactive: get: - summary: Get attribute by inum - description: Get an attribute by inum - operationId: getAttributeByInum - parameters: - - name: inum - in: path - required: true - schema: - type: string + summary: Get all inactive attributes + description: Gets all inative attributes + operationId: getAllInactiveAttributes responses: 200: description: success content: application/json: schema: - $ref: '#/components/schemas/GluuAttribute' + type: string 500: description: Server error security: @@ -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,49 +510,39 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.client.write - /api/v1/clients/{inum}/scopes/{sinum}: - post: - summary: Add OIDC client scopes - description: Add scopes to OIDC client - operationId: addScopeToClient + /api/v1/clients/{inum}: + get: + summary: Get OIDC client + description: Get a specific OIDC client + operationId: getClientByInum parameters: - name: inum in: path required: true schema: type: string - - name: sinum - in: path - required: true - schema: - type: string 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.write + - https://gluu.org/auth/oxtrust.client.read delete: - summary: Remove OIDC client scope - description: Remove an existing scope from client - operationId: removeScopeToClient + 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 @@ -715,63 +715,6 @@ paths: security: - oauth2: - https://gluu.org/auth/oxtrust.customscript.read - /api/v1/groups: - get: - summary: Get groups - description: Get groups - operationId: listGroups - parameters: - - name: size - in: query - schema: - type: integer - format: int32 - default: 0 - responses: - 200: - description: Success - content: - application/json: - schema: - type: string - 500: - description: Server error - put: - summary: Update group - description: Update a group - operationId: updateGroup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GluuGroupApi' - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GluuGroupApi' - 500: - description: Server error - post: - summary: Add group - description: Add a group - operationId: createGroup - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/GluuGroupApi' - responses: - 201: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/GluuGroupApi' - 500: - description: Server error /api/v1/groups/search: get: summary: Search groups @@ -798,36 +741,46 @@ 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 + /api/v1/groups/{inum}/members/{minum}: + post: + summary: Add group member + description: Add group member + operationId: addGroupMember parameters: - name: inum in: path required: true schema: type: string + - name: minum + in: path + required: true + schema: + type: string responses: 200: description: Success 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 @@ -868,22 +821,18 @@ paths: description: default response content: application/json: {} - /api/v1/groups/{inum}/members/{minum}: - post: - summary: Add group member - description: Add group member - operationId: addGroupMember + /api/v1/groups: + get: + summary: Get groups + description: Get groups + operationId: listGroups parameters: - - name: inum - in: path - required: true - schema: - type: string - - name: minum - in: path - required: true + - name: size + in: query schema: - type: string + type: integer + format: int32 + default: 0 responses: 200: description: Success @@ -893,17 +842,68 @@ paths: type: string 500: description: Server error - delete: - summary: Remove group member - description: Remove a member from group - operationId: removeGroupMember - parameters: - - name: inum - in: path - required: true - schema: - type: string - - name: minum + put: + summary: Update group + description: Update a group + operationId: updateGroup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GluuGroupApi' + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GluuGroupApi' + 500: + description: Server error + post: + summary: Add group + description: Add a group + operationId: createGroup + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/GluuGroupApi' + responses: + 201: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/GluuGroupApi' + 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: @@ -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 @@ -1567,6 +1567,41 @@ paths: $ref: '#/components/schemas/ScimConfig' 500: description: Server error + /api/v1/scopes/{inum}: + get: + summary: Get openid scope + description: Get a specific openid connect scope + operationId: getScopeByInum + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + content: + application/json: + schema: + $ref: '#/components/schemas/Scope' + 500: + description: Server error + delete: + summary: Delete openid connect scope + description: Delete an openidconnect scope + operationId: deleteScope + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + 500: + description: Server error /api/v1/scopes: get: summary: Get all scopes @@ -1617,11 +1652,11 @@ paths: $ref: '#/components/schemas/Scope' 500: description: Server error - /api/v1/scopes/{inum}: + /api/v1/scopes/{inum}/claims: get: - summary: Get openid scope - description: Get a specific openid connect scope - operationId: getScopeByInum + summary: Get scope claims + description: List all claims of a scope + operationId: getScopeClaims parameters: - name: inum in: path @@ -1634,31 +1669,41 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Scope' + type: string 500: description: Server error - delete: - summary: Delete openid connect scope - description: Delete an openidconnect scope - operationId: deleteScope + /api/v1/scopes/search: + get: + 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 + content: + application/json: + schema: + type: string 500: description: Server error - /api/v1/scopes/{inum}/claims: + /api/v1/sectoridentifiers/sector/{id}: get: - summary: Get scope claims - description: List all claims of a scope - operationId: getScopeClaims + summary: Get sector identifier + description: Get a sector identifier + operationId: getSectorIdentifierById parameters: - - name: inum + - name: id in: path required: true schema: @@ -1669,14 +1714,30 @@ paths: content: application/json: schema: - type: string + $ref: '#/components/schemas/OxAuthSectorIdentifier' 500: description: Server error - /api/v1/scopes/search: + /api/v1/sectoridentifiers/{inum}: + delete: + summary: Delete sector identifier + description: Delete a sector identifier + operationId: deleteSectorIdentifier + parameters: + - name: inum + in: path + required: true + schema: + type: string + responses: + 200: + description: Success + 500: + description: Server error + /api/v1/sectoridentifiers/search: get: - summary: Search openid connect scopes - description: Search openid connect scopes - operationId: searchScope + summary: Search sector identifiers + description: Search sectors identifiers + operationId: searchSectorIdentifier parameters: - name: pattern in: query @@ -1747,79 +1808,52 @@ paths: $ref: '#/components/schemas/OxAuthSectorIdentifier' 500: description: Server error - /api/v1/sectoridentifiers/sector/{id}: + /api/v1/configuration/status: get: - summary: Get sector identifier - description: Get a sector identifier - operationId: getSectorIdentifierById - parameters: - - name: id - in: path - required: true - schema: - type: string + summary: Get server status + description: Get server status + operationId: getServerStatus responses: 200: description: Success content: application/json: schema: - $ref: '#/components/schemas/OxAuthSectorIdentifier' + $ref: '#/components/schemas/GluuServerStatus' 500: description: Server error - /api/v1/sectoridentifiers/search: + /api/v1/configuration/smtp: 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 + summary: Get smtp configuration + description: Get smtp configuration + operationId: getSmtpServerConfiguration responses: 200: - description: Success + description: success content: application/json: schema: - type: string + $ref: '#/components/schemas/SmtpConfiguration' 500: description: Server error - /api/v1/sectoridentifiers/{inum}: - delete: - summary: Delete sector identifier - description: Delete a sector identifier - operationId: deleteSectorIdentifier - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - 500: - description: Server error - /api/v1/configuration/status: - get: - summary: Get server status - description: Get server status - operationId: getServerStatus + put: + summary: Update smtp configuration + description: Update smtp configuration + operationId: updateSmtpConfiguration + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/SmtpConfiguration' responses: 200: - description: Success + description: success content: application/json: schema: - $ref: '#/components/schemas/GluuServerStatus' + $ref: '#/components/schemas/SmtpConfiguration' + 404: + description: Not found 500: description: Server error /api/v1/configuration/smtp/test: @@ -1836,70 +1870,159 @@ paths: $ref: '#/components/schemas/SmtpConfiguration' 500: description: Server error - /api/v1/configuration/smtp: + /configuration/system: get: - summary: Get smtp configuration - description: Get smtp configuration - operationId: getSmtpServerConfiguration + summary: Retrieve system configuration + description: Retrieve system configuration + operationId: retrieveSystemConfiguration responses: 200: description: success content: application/json: schema: - $ref: '#/components/schemas/SmtpConfiguration' + $ref: '#/components/schemas/SystemConfig' 500: description: Server error put: - summary: Update smtp configuration - description: Update smtp configuration - operationId: updateSmtpConfiguration + summary: Update system configuration + description: Update system configuration + operationId: updateSystemConfiguration requestBody: content: application/json: schema: - $ref: '#/components/schemas/SmtpConfiguration' + $ref: '#/components/schemas/SystemConfig' responses: 200: description: success content: application/json: schema: - $ref: '#/components/schemas/SmtpConfiguration' - 404: - description: Not found + $ref: '#/components/schemas/SystemConfig' 500: description: Server error - /configuration/system: + /api/v1/saml/tr/get_contacts/{inum}: get: - summary: Retrieve system configuration - description: Retrieve system configuration - operationId: retrieveSystemConfiguration + operationId: getContacts + parameters: + - name: inum + in: path + required: true + schema: + type: string responses: 200: - description: success + description: OK content: - application/json: + text/plain: schema: - $ref: '#/components/schemas/SystemConfig' + type: string 500: description: Server error - put: - summary: Update system configuration - description: Update system configuration - operationId: updateSystemConfiguration + /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: - $ref: '#/components/schemas/SystemConfig' + type: string responses: 200: - description: success + description: OK + 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/list_all_federations: + get: + operationId: listAllFederations + responses: + 200: + description: OK content: application/json: schema: - $ref: '#/components/schemas/SystemConfig' + type: string + 500: + description: Server error + /api/v1/saml/tr/set_certificate/{inum}: + post: + summary: set certificate for TrustRelationship + description: Find TrustRelationship by inum and set certificate. + operationId: setCertificate + parameters: + - name: inum + in: path + required: true + schema: + type: string + requestBody: + content: + text/plain: + schema: + type: string + responses: + 200: + description: OK + 500: + description: Server error + /api/v1/saml/tr/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/update/{inum}: @@ -2016,29 +2139,6 @@ 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 @@ -2052,24 +2152,9 @@ paths: description: default response content: text/plain: {} - /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_contacts/{inum}: + /api/v1/saml/tr/set_metadata/{inum}: post: - summary: set contacts for TrustRelationship - description: Find TrustRelationship by inum and set contacts. Contacts parameter - is List - operationId: setContacts + operationId: setMetadata parameters: - name: inum in: path @@ -2078,25 +2163,9 @@ paths: type: string requestBody: content: - application/json: + application/xml: schema: type: string - responses: - 200: - description: OK - 500: - description: Server error - /api/v1/saml/tr/set_metadata_url/{inum}: - post: - operationId: setMetadataURL - parameters: - - name: inum - in: path - required: true - schema: - type: string - requestBody: - content: text/plain: schema: type: string @@ -2106,79 +2175,14 @@ paths: 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/set_certificate/{inum}: - post: - summary: set certificate for TrustRelationship - description: Find TrustRelationship by inum and set certificate. - operationId: setCertificate - parameters: - - name: inum - in: path - required: true - schema: - type: string - requestBody: - content: - text/plain: - schema: - type: string - responses: - 200: - description: OK - 500: - description: Server error - /api/v1/saml/tr/list_all_other_federations/{inum}: - get: - operationId: listAllOtherFederations - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: OK - content: - application/json: - schema: - type: string - 500: - description: Server error - /api/v1/saml/tr/list_all_saml_trust_relationships: - get: - operationId: listAllSAMLTrustRelationships - parameters: - - name: size_limit - in: query - schema: - type: integer - format: int32 + /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: - application/json: - schema: - type: string 500: description: Server error /api/v1/saml/tr/search_trust_relationships: @@ -2204,31 +2208,27 @@ paths: type: string 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 - 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 + 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/list_deconstructed_trust_relationships/{inum}: + /api/v1/saml/tr/list_all_other_federations/{inum}: get: - operationId: listDeconstructedTrustRelationships + operationId: listAllOtherFederations parameters: - name: inum in: path @@ -2244,14 +2244,14 @@ paths: type: string 500: description: Server error - /api/v1/saml/tr/generate_inum_for_new_trust_relationship: + /api/v1/saml/tr/list_all_active_trust_relationships: get: - operationId: generateInumForNewTrustRelationship + operationId: listAllActiveTrustRelationships responses: 200: description: OK content: - text/plain: + application/json: schema: type: string 500: @@ -2290,28 +2290,6 @@ paths: description: Trust Relation already exists 500: description: Server error - /api/v1/inbound-saml/trusted-idp/inum/{inum}: - get: - summary: Get TrustedIDP by inum - description: Get a TrustedIDP by inum - operationId: gluuTrustedIdp - parameters: - - name: inum - in: path - required: true - schema: - type: string - responses: - 200: - description: Success - content: - application/json: - schema: - $ref: '#/components/schemas/TrustedIDPApi' - 404: - description: Resource not Found - 500: - description: Server error /api/v1/inbound-saml/trusted-idp/{remoteIdpHost}: get: summary: Get TrustedIDP by remote idp host @@ -2375,55 +2353,68 @@ paths: description: Success 500: description: Server error - /api/v1/uma/resources/search: + /api/v1/inbound-saml/trusted-idp/inum/{inum}: get: - summary: Search UMA resources - description: Search uma resources - operationId: searchUmaResources + summary: Get TrustedIDP by inum + description: Get a TrustedIDP by inum + operationId: gluuTrustedIdp parameters: - - name: pattern - in: query + - name: inum + in: path required: true schema: type: string - - name: size - in: query - required: true - schema: - type: integer - format: int32 responses: 200: description: Success content: application/json: schema: - type: string + $ref: '#/components/schemas/TrustedIDPApi' + 404: + description: Resource not Found 500: description: Server error - /api/v1/uma/resources: - get: - summary: Get UMA resources - description: Get uma resources - operationId: listUmaResources + /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: - 200: + 201: description: Success content: application/json: schema: - type: string + $ref: '#/components/schemas/UmaResource' 500: description: Server error - put: - summary: Update UMA resource - description: Update uma resource - operationId: updateUmaResource - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' + 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 @@ -2433,15 +2424,22 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error + /api/v1/uma/resources/{id}/scopes/{inum}: post: - summary: Add new UMA resource - description: Add new uma resource - operationId: createUmaResource - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/UmaResource' + 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 @@ -2451,17 +2449,21 @@ 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 + 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 @@ -2471,10 +2473,11 @@ paths: $ref: '#/components/schemas/UmaResource' 500: description: Server error - delete: - summary: Delete UMA resource - description: Delete a uma resource - operationId: deleteUmaResource + /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 @@ -2482,10 +2485,10 @@ paths: schema: type: string responses: - 200: - description: Success - 500: - description: Server error + default: + description: default response + content: + application/json: {} /api/v1/uma/resources/{id}/scopes: get: summary: Get UMA resource scopes @@ -2502,87 +2505,93 @@ 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/search: + get: + 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: - 201: + 200: description: Success content: application/json: schema: - $ref: '#/components/schemas/UmaResource' + type: string 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 + /api/v1/uma/resources: + get: + summary: Get UMA resources + description: Get uma resources + operationId: listUmaResources responses: 200: description: Success content: application/json: schema: - $ref: '#/components/schemas/UmaResource' + type: string 500: description: Server error - /api/v1/uma/resources/{id}/clients: - get: - summary: Get clients of UMA resources - description: Get clients of uma resource - operationId: getUmaResourceClients - parameters: - - name: id - in: path - required: true - schema: - type: string + put: + summary: Update UMA resource + description: Update uma resource + operationId: updateUmaResource + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' responses: - default: - description: default response + 200: + description: Success content: - application/json: {} - /api/v1/uma/resources/{id}/scopes/{inum}: + application/json: + schema: + $ref: '#/components/schemas/UmaResource' + 500: + description: Server error post: - summary: Add UMA resource scope - description: add scope to uma resource - operationId: addScopeToUmaResource + 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 @@ -2593,27 +2602,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/scopes/{inum}: @@ -2721,6 +2721,49 @@ paths: 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: + $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 @@ -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,17 +2998,17 @@ components: $ref: '#/components/schemas/AttributeValidation' gluuTooltip: type: string - adminCanAccess: - type: boolean - userCanView: + userCanAccess: type: boolean adminCanEdit: type: boolean - userCanAccess: + userCanView: + type: boolean + adminCanView: type: boolean userCanEdit: type: boolean - adminCanView: + adminCanAccess: type: boolean whitePagesCanView: type: boolean @@ -3108,6 +3108,67 @@ 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: @@ -3461,74 +3522,13 @@ components: - PS384 - PS512 backchannelTokenDeliveryMode: - type: string - backchannelClientNotificationEndpoint: - type: string - backchannelUserCodeParameter: - 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: string + backchannelClientNotificationEndpoint: + type: string + backchannelUserCodeParameter: type: boolean + baseDn: + type: string CacheConfiguration: type: object properties: @@ -3871,8 +3871,6 @@ components: SmtpConfiguration: type: object properties: - valid: - type: boolean connectProtectionList: type: array items: @@ -3881,6 +3879,8 @@ components: - None - StartTls - SslTls + valid: + type: boolean host: type: string port: @@ -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,75 +4638,6 @@ components: type: string cookieDomain: type: string - OxTrustBasicConfig: - type: object - properties: - baseDN: - type: string - orgSupportEmail: - type: string - applicationUrl: - type: string - baseEndpoint: - type: string - ldifStore: - type: string - updateStatus: - type: boolean - keystorePath: - type: string - allowPersonModification: - type: boolean - configGeneration: - type: boolean - gluuSpCert: - type: string - certDir: - type: string - servicesRestartTrigger: - type: string - loginRedirectUrl: - type: string - logoutRedirectUrl: - type: string - clientAssociationAttribute: - type: string - ignoreValidation: - type: boolean - umaIssuer: - type: string - cssLocation: - type: string - jsLocation: - type: string - enableUpdateNotification: - type: boolean - oxIncommonFlag: - type: boolean - clientWhiteList: - type: array - items: - type: string - clientBlackList: - type: array - items: - type: string - loggingLevel: - type: string - organizationName: - type: string - disableJdkLogger: - type: boolean - passwordResetRequestExpirationTime: - type: integer - format: int32 - cleanServiceInterval: - type: integer - format: int32 - enforceEmailUniqueness: - type: boolean - useLocalCache: - type: boolean AppConfiguration: type: object properties: @@ -4961,6 +4892,75 @@ components: - BYPASS userExtensionSchemaURI: type: string + OxTrustBasicConfig: + type: object + properties: + baseDN: + type: string + orgSupportEmail: + type: string + applicationUrl: + type: string + baseEndpoint: + type: string + ldifStore: + type: string + updateStatus: + type: boolean + keystorePath: + type: string + allowPersonModification: + type: boolean + configGeneration: + type: boolean + gluuSpCert: + type: string + certDir: + type: string + servicesRestartTrigger: + type: string + loginRedirectUrl: + type: string + logoutRedirectUrl: + type: string + clientAssociationAttribute: + type: string + ignoreValidation: + type: boolean + umaIssuer: + type: string + cssLocation: + type: string + jsLocation: + type: string + enableUpdateNotification: + type: boolean + oxIncommonFlag: + type: boolean + clientWhiteList: + type: array + items: + type: string + clientBlackList: + type: array + items: + type: string + loggingLevel: + type: string + organizationName: + type: string + disableJdkLogger: + type: boolean + passwordResetRequestExpirationTime: + type: integer + format: int32 + cleanServiceInterval: + type: integer + format: int32 + enforceEmailUniqueness: + type: boolean + useLocalCache: + type: boolean OxTrustJsonSetting: type: object properties: @@ -5226,6 +5226,37 @@ components: type: string allowProfileManagement: type: string + TrustContact: + type: object + properties: + name: + type: string + phone: + type: string + mail: + type: string + title: + type: string + SAMLTrustRelationshipShort: + type: object + properties: + inum: + type: string + displayName: + type: string + description: + type: string + validationStatus: + type: string + enum: + - In Progress + - Success + - Scheduled + - Failed + releasedAttributes: + type: array + items: + type: string GluuCustomAttribute: type: object properties: @@ -5250,7 +5281,9 @@ components: - "true" - inactive - active - displayValue: + multiValued: + type: boolean + value: type: object booleanValue: type: string @@ -5261,28 +5294,26 @@ components: - "true" - inactive - active - adminCanAccess: - type: boolean - userCanView: + stringValue: + type: string + stringValues: + type: array + items: + type: string + userCanAccess: type: boolean adminCanEdit: type: boolean - userCanAccess: + userCanView: + type: boolean + adminCanView: type: boolean userCanEdit: type: boolean - adminCanView: + adminCanAccess: type: boolean new: type: boolean - stringValues: - type: array - items: - type: string - stringValue: - type: string - multiValued: - type: boolean GluuSAMLTrustRelationship: required: - description @@ -5395,20 +5426,20 @@ components: type: string certificate: type: string - federation: - type: boolean - entityId: - type: string - specificRelyingPartyConfig: - type: boolean - containerFederation: - $ref: '#/components/schemas/GluuSAMLTrustRelationship' uniqueGluuEntityId: uniqueItems: true type: array writeOnly: true items: type: string + entityId: + type: string + containerFederation: + $ref: '#/components/schemas/GluuSAMLTrustRelationship' + specificRelyingPartyConfig: + type: boolean + federation: + type: boolean researchBundle: type: boolean baseDn: @@ -5481,37 +5512,6 @@ components: type: array items: type: string - SAMLTrustRelationshipShort: - type: object - properties: - inum: - type: string - displayName: - type: string - description: - type: string - validationStatus: - type: string - enum: - - In Progress - - Success - - Scheduled - - Failed - releasedAttributes: - type: array - items: - type: string - TrustContact: - type: object - properties: - name: - type: string - phone: - type: string - mail: - type: string - title: - type: string RemoteIdp: type: object properties: