{ "opencollection": "1.0.0", "info": { "name": "Flowable REST Access Tokens Groups API", "version": "v1" }, "items": [ { "info": { "name": "Groups", "type": "folder" }, "items": [ { "info": { "name": "List groups", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/identity/groups", "params": [ { "name": "id", "value": "", "type": "query", "description": "Only return group with the given id" }, { "name": "name", "value": "", "type": "query", "description": "Only return groups with the given name" }, { "name": "type", "value": "", "type": "query", "description": "Only return groups with the given type" }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return groups with a name like the given value. Use % as wildcard-character." }, { "name": "member", "value": "", "type": "query", "description": "Only return groups which have a member with the given username." }, { "name": "potentialStarter", "value": "", "type": "query", "description": "Only return groups which members are potential starters for a process-definition with the given id." }, { "name": "sort", "value": "", "type": "query", "description": "Property to sort on, to be used together with the order." }, { "name": "order", "value": "", "type": "query", "description": "The sort order, either 'asc' or 'desc'. Defaults to 'asc'." }, { "name": "start", "value": "", "type": "query", "description": "Index of the first row to fetch. Defaults to 0." }, { "name": "size", "value": "", "type": "query", "description": "Number of rows to fetch, starting from start. Defaults to 10." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List groups" }, { "info": { "name": "Create a group", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/identity/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a group" }, { "info": { "name": "Get a single group", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/identity/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a single group" }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/identity/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All request values are optional. For example, you can only include the name attribute in the request body JSON-object, only updating the name of the group, leaving all other fields unaffected. When an attribute is explicitly included and is set to null, the group-value will be updated to null." }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/identity/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a group" }, { "info": { "name": "Add a member to a group", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/identity/groups/:groupId/members", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Add a member to a group" }, { "info": { "name": "Delete a member from a group", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/identity/groups/:groupId/members/:userId", "params": [ { "name": "groupId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a member from a group" }, { "info": { "name": "List groups", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/groups", "params": [ { "name": "id", "value": "", "type": "query", "description": "Only return group with the given id" }, { "name": "name", "value": "", "type": "query", "description": "Only return groups with the given name" }, { "name": "type", "value": "", "type": "query", "description": "Only return groups with the given type" }, { "name": "nameLike", "value": "", "type": "query", "description": "Only return groups with a name like the given value." }, { "name": "nameLikeIgnoreCase", "value": "", "type": "query", "description": "Only return groups with a name like the given value ignoring case." }, { "name": "member", "value": "", "type": "query", "description": "Only return groups which have a member with the given username." }, { "name": "key", "value": "", "type": "query", "description": "Only return groups with the given key." }, { "name": "tenantId", "value": "", "type": "query", "description": "Only return groups with the given tenant ID." }, { "name": "includeIdentityInfo", "value": "", "type": "query", "description": "Include the group identity info in the response." }, { "name": "sort", "value": "", "type": "query", "description": "Property to sort on, to be used together with the order." } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "List groups" }, { "info": { "name": "Create a group", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Create a group" }, { "info": { "name": "Get a single group", "type": "http" }, "http": { "method": "GET", "url": "/flowable-rest/service/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" }, { "name": "includeUserInfo", "value": "", "type": "query" }, { "name": "includePrivilegeInfo", "value": "", "type": "query" }, { "name": "includeIdentityInfo", "value": "", "type": "query" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Get a single group" }, { "info": { "name": "Update a group", "type": "http" }, "http": { "method": "PUT", "url": "/flowable-rest/service/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "All request values are optional. For example, you can only include the name attribute in the request body JSON-object, only updating the name of the group, leaving all other fields unaffected. When an attribute is explicitly included and is set to null, the group-value will be updated to null." }, { "info": { "name": "Delete a group", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/groups/:groupId", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a group" }, { "info": { "name": "Add a member to a group", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/groups/:groupId/members", "params": [ { "name": "groupId", "value": "", "type": "path" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Add a member to a group" }, { "info": { "name": "Delete a member from a group", "type": "http" }, "http": { "method": "DELETE", "url": "/flowable-rest/service/groups/:groupId/members/:userId", "params": [ { "name": "groupId", "value": "", "type": "path" }, { "name": "userId", "value": "", "type": "path" } ], "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Delete a member from a group" }, { "info": { "name": "Query groups", "type": "http" }, "http": { "method": "POST", "url": "/flowable-rest/service/query/groups", "body": { "type": "json", "data": "{}" }, "auth": { "type": "basic", "username": "{{username}}", "password": "{{password}}" } }, "docs": "Query groups" } ] } ], "bundled": true }