{ "opencollection": "1.0.0", "info": { "name": "Controlplane Api ApiChangelog Groups API", "version": "1.0.0" }, "items": [ { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "Get group hierarchy.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/:realm/groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "briefRepresentation", "value": "", "type": "query" }, { "name": "first", "value": "", "type": "query" }, { "name": "max", "value": "", "type": "query" }, { "name": "search", "value": "", "type": "query" } ] }, "docs": "Get group hierarchy." }, { "info": { "name": "create or add a top level realm groupSet or create child.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telekom.de/controlplane/v1/:realm/groups", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" } ], "body": { "type": "json", "data": "{}" } }, "docs": "create or add a top level realm groupSet or create child." }, { "info": { "name": "Returns the groups counts.", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/count", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "search", "value": "", "type": "query" }, { "name": "top", "value": "", "type": "query" } ] }, "docs": "Returns the groups counts." }, { "info": { "name": "GET /{realm}/groups/{id}", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "Update group, ignores subgroups.", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Update group, ignores subgroups." }, { "info": { "name": "DELETE /{realm}/groups/{id}", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/:id", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] } }, { "info": { "name": "Set or create child.", "type": "http" }, "http": { "method": "POST", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/:id/children", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Set or create child." }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/:id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ] }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "Return object stating whether client Authorization permissions have been initialized or not and a reference", "type": "http" }, "http": { "method": "PUT", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/:id/management/permissions", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" } }, "docs": "Return object stating whether client Authorization permissions have been initialized or not and a reference" }, { "info": { "name": "Get users Returns a list of users, filtered according to query parameters", "type": "http" }, "http": { "method": "GET", "url": "https://api.telekom.de/controlplane/v1/:realm/groups/:id/members", "params": [ { "name": "realm", "value": "", "type": "path", "description": "realm name (not id!)" }, { "name": "id", "value": "", "type": "path" }, { "name": "briefRepresentation", "value": "", "type": "query", "description": "Only return basic information (only guaranteed to return id, username, created, first and last name,\n email, enabled state, email verification state, federation link, and access.\n Note that it means that namely user attributes, required actions, and not before are not returned.)" }, { "name": "first", "value": "", "type": "query", "description": "Pagination offset" }, { "name": "max", "value": "", "type": "query", "description": "Maximum results size (defaults to 100)" } ] }, "docs": "Get users Returns a list of users, filtered according to query parameters" } ] } ], "bundled": true }