GET
/groups/{name}Get group by name
Returns the group with the given name if it exists
namestringrequired
group name
confidential_dataintegeroptional
If set to 1 confidential data will not be hidden. This means that the response will contain the key and additional data for secrets. Ignored if the * permission is not granted.
200successful operation
adminsarray<string>optional
list of admins usernames associated with this group
created_atintegeroptional
Creation time as Unix timestamp in milliseconds.
descriptionstringoptional
Optional free-form description.
idintegeroptional
namestringrequired
Unique group name. Referenced from `User.groups[].name` with a type (primary/secondary/membership).
rolestringoptional
Role name. A group carrying a role with `resource_isolation` enabled is visible to the admins carrying the same role, it is reachable from the accounts of that role and its storage is measured against the allowlist of the role. An admin carrying a role receives that role on the groups it creates. On update the body replaces the stored role: omitting it clears the role, and the change is refused while accounts or admins of another role reference the group
updated_atintegeroptional
Last update time as Unix timestamp in milliseconds.
user_settingsobjectoptional
usersarray<string>optional
list of usernames associated with this group
virtual_foldersarray<object>optional
mapping between virtual SFTPGo paths and folders
400Bad Request
errorstringoptional
error description if any
messagestringoptional
message, can be empty
401Unauthorized
errorstringoptional
error description if any
messagestringoptional
message, can be empty
403Forbidden
errorstringoptional
error description if any
messagestringoptional
message, can be empty
404Not Found
errorstringoptional
error description if any
messagestringoptional
message, can be empty
500Internal Server Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
defaultUnexpected Error
errorstringoptional
error description if any
messagestringoptional
message, can be empty
Error handling
A 400 is returned: Bad Request. A 401 is returned: Unauthorized. A 403 is returned: Forbidden. A 404 is returned: Not Found. A 500 is returned: Internal Server Error. Any other status is an error: Unexpected Error.