v1

latestOpenAPI 3.0.12026-07-178692133.1 KB
GroupService

Update a group

put/mr-api/group/{gid}

Query parameters

updateMembersboolean

update members, deleting those that are not passed

updateEnvironmentGroupRolesboolean

update environment group roles, deleting any not passed

updateApplicationGroupRolesboolean

update application group roles, deleting any not passed

applicationIdstring uuid

if updating the application group roles, and the application id is passed, then the changes are limited to that application

Request body

whenCreatedstring date-time
whenUpdatedstring date-time
idstring uuid
adminboolean

is this an admin group?

portfolioIdstring uuid
organizationIdstring uuid

this will be the organisation this group belongs to at the top level, or if a portfolio group, the organisation of the portfolio

versioninteger
namestring required
whenArchivedstring date-time

Response

Resulting group

whenCreatedstring date-time
whenUpdatedstring date-time
idstring uuid
adminboolean

is this an admin group?

portfolioIdstring uuid
organizationIdstring uuid

this will be the organisation this group belongs to at the top level, or if a portfolio group, the organisation of the portfolio

versioninteger
namestring required
whenArchivedstring date-time