{ "opencollection": "1.0.0", "info": { "name": "Mend Access Management User Management - Groups API", "version": "3.0" }, "request": { "auth": { "type": "bearer", "token": "{{bearerToken}}" } }, "items": [ { "info": { "name": "User Management - Groups", "type": "folder" }, "items": [ { "info": { "name": "Get Group", "type": "http" }, "http": { "method": "GET", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization)." } ] }, "docs": "Returns the given group of an organization" }, { "info": { "name": "Update Group", "type": "http" }, "http": { "method": "PUT", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Updates the properties of a given group" }, { "info": { "name": "Delete Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization)." } ] }, "docs": "Deletes the given group" }, { "info": { "name": "Get Group Users", "type": "http" }, "http": { "method": "GET", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid/users", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Enter the number of items to return in each page of the result." }, { "name": "page", "value": "", "type": "query", "description": "Enter the page number to display in the result. Page numbers start at 0" }, { "name": "search", "value": "", "type": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ accountStatus:[equals|in]:value\n+ email:[like | equals | regex]:value\n+ name:[like | equals | regex]:value\n+ userType:[like | equals]:value\n+ roles:[equals|in]:value" }, { "name": "sort", "value": "", "type": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ email\n+ name\n+ userType" }, { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "The group UUID" } ] }, "docs": "Returns a list of users that belong to given group" }, { "info": { "name": "Add User To Group", "type": "http" }, "http": { "method": "POST", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid/users", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Adds a user to an organization's group" }, { "info": { "name": "Get Group Roles", "type": "http" }, "http": { "method": "GET", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid/roles", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Enter the number of items to return in each page of the result." }, { "name": "page", "value": "", "type": "query", "description": "Enter the page number to display in the result. Page numbers start at 0" }, { "name": "search", "value": "", "type": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ contextName:[like | equals | regex]:value\n+ contextType[like | equals]:value\n+ role[like | equals | regex]:value" }, { "name": "sort", "value": "", "type": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ contextName\n+ contextType\n+ role" }, { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "The group UUID" } ] }, "docs": "Returns the list of roles associated with a given group" }, { "info": { "name": "Add Group Role", "type": "http" }, "http": { "method": "POST", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid/roles", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new group role for an organization" }, { "info": { "name": "Remove Group Roles", "type": "http" }, "http": { "method": "DELETE", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid/roles", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Deletes a role from a group" }, { "info": { "name": "Get All Groups of organization", "type": "http" }, "http": { "method": "GET", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups", "params": [ { "name": "pageSize", "value": "", "type": "query", "description": "Enter the number of items to return in each page of the result." }, { "name": "page", "value": "", "type": "query", "description": "Enter the page number to display in the result. Page numbers start at 0" }, { "name": "search", "value": "", "type": "query", "description": "Filter your search to return items whose property has a specific value.\nUse the syntax: **property:operation:value** where a colon (:) separates between property, operation and value.\n+ Property: the name of the property of the item\n+ Operation:\n + **equals** - true if the value is identical to this value.\n + **in** - true if the value is identical to one of the items in this comma-separated list. E.g. in:value1,value2,value3\n + **like** - true if the property's value is contained within this value\n + **regex** - true if this regular expression resolves as true.\n The regex is not case sensitive, and special characters must be escaped with a backslash.\n Special characters include space, double quote (\"), '<', '>', '#', '%', '{', '}', vertical bar ('|'), backslash, '^'.\n To pass an escaped character in a URL in Postman, encode it first.\n E.g. to return all items whose value begins with **a** or **A**, use regex:^a\n+ Value: the value of the property.\n\nTo combine multiple filters, separate each filter with a semicolon with no space. E.g. property1:operation1:value1;property2:operation2:value2\n\nThis endpoint supports filtering on the following properties and its supported operators:\n+ contextType:equals:value\n+ name:[like | equals | regex]:value\n+ product:in:value1,value2,value-n\n+ roles:in:value1,value2,value-n" }, { "name": "sort", "value": "", "type": "query", "description": "Sort search results alphabetically on an item's property by entering **sort=** followed by the property name.\nE.g. enter **sort=email** to sort alphabetically by their email addresses from a-z ascending.To sort in descending order (z-a), add a minus sign ('-'). E.g. **sort=-email**.\n\nYou can sort by the following properties:\n+ accountStatus\n+ contextType\n+ name\n+ product\n+ role\n+ users" }, { "name": "groupRolesByScope", "value": "", "type": "query", "description": "This query parameter allows you to group the roles assigned to a group by their scope (application/org). When set to true, the response will organize the roles into groups based on their associated application labels. This makes it easier to see which roles are linked to which applications within the group. " }, { "name": "optionalColumns", "value": "", "type": "query", "description": "Used to add group roles information to the response" }, { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." } ] }, "docs": "Returns a list of all groups within an organization" }, { "info": { "name": "Create Group", "type": "http" }, "http": { "method": "POST", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." } ], "body": { "type": "json", "data": "{}" } }, "docs": "Creates a new group for an organization" }, { "info": { "name": "Delete User From Group", "type": "http" }, "http": { "method": "DELETE", "url": "https://baseUrl/api/v2.0/orgs/:orgToken/groups/:groupUuid/users/:userUuid", "params": [ { "name": "orgToken", "value": "", "type": "path", "description": "org UUID (by running Entities - Organization > Get User Organizations) or API Key (from the Mend SCA App: **Integrate** tab > **API Key**)." }, { "name": "groupUuid", "value": "", "type": "path", "description": "Group UUID (by running User Management - Groups > Get All Groups of Organization)." }, { "name": "userUuid", "value": "", "type": "path", "description": "User UUID (by running User Management - Users > Get Organization Users)." } ] }, "docs": "Deletes a user from an organization's group" } ] } ], "bundled": true }