groups

« Previous section Next section »

UCloud Developer Guide / Legacy / Projects (Legacy) / Groups

Groups

Project groups help PIs organize a Project.

Rationale

This API will likely be combined with one or more related APIs in the project feature.

---

⚠️ WARNING: The API listed on this page will likely change to conform with our API conventions. Be careful when building integrations. The following changes are expected:

• RPC names will change to conform with the conventions

• RPC request and response types will change to conform with the conventions

• RPCs which return a page will be collapsed into a single browse endpoint

• Some property names will change to be consistent with Resources

---

Table of Contents

1. Remote Procedure Calls

2. Data Models

Remote Procedure Calls

count

Request	Response	Error
Unit	Long	CommonErrorMessage

groupExists

Request	Response	Error
GroupExistsRequest	GroupExistsResponse	CommonErrorMessage

isMember

Request	Response	Error
IsMemberRequest	IsMemberResponse	CommonErrorMessage

listAllGroupIdsAndTitles

Request	Response	Error
Unit	ListAllGroupIdsAndTitlesResponse	CommonErrorMessage

listGroupMembers

Request	Response	Error
ListGroupMembersRequest	Page<String>	CommonErrorMessage

listGroupsWithSummary

Request	Response	Error
ListGroupsWithSummaryRequest	Page<GroupWithSummary>	CommonErrorMessage

lookupByTitle

Request	Response	Error
LookupByGroupTitleRequest	GroupWithSummary	CommonErrorMessage

lookupProjectAndGroup

Request	Response	Error
LookupProjectAndGroupRequest	ProjectAndGroup	CommonErrorMessage

view

Request	Response	Error
ViewGroupRequest	GroupWithSummary	CommonErrorMessage

addGroupMember

Request	Response	Error
AddGroupMemberRequest	Unit	CommonErrorMessage

create

Request	Response	Error
CreateGroupRequest	FindByStringId	CommonErrorMessage

delete

Request	Response	Error
DeleteGroupsRequest	Unit	CommonErrorMessage

listAllGroupMembers

Request	Response	Error
ListAllGroupMembersRequest	List<String>	CommonErrorMessage

removeGroupMember

Request	Response	Error
RemoveGroupMemberRequest	Unit	CommonErrorMessage

updateGroupName

Request	Response	Error
UpdateGroupNameRequest	Unit	CommonErrorMessage

Data Models

GroupWithSummary

data class GroupWithSummary(
    val groupId: String,
    val groupTitle: String,
    val numberOfMembers: Int,
)

Properties

---

IsMemberQuery

data class IsMemberQuery(
    val project: String,
    val group: String,
    val username: String,
)

Properties

---

ProjectAndGroup

data class ProjectAndGroup(
    val project: Project,
    val group: ProjectGroup,
)

Properties

---

ProjectGroup

data class ProjectGroup(
    val id: String,
    val title: String,
)

Properties

---

AddGroupMemberRequest

data class AddGroupMemberRequest(
    val group: String,
    val memberUsername: String,
)

Properties

---

CreateGroupRequest

data class CreateGroupRequest(
    val group: String,
)

Properties

---

DeleteGroupsRequest

data class DeleteGroupsRequest(
    val groups: List<String>,
)

Properties

---

GroupExistsRequest

data class GroupExistsRequest(
    val project: String,
    val groups: List<String>,
)

Properties

---

IsMemberRequest

data class IsMemberRequest(
    val queries: List<IsMemberQuery>,
)

Properties

---

ListAllGroupMembersRequest

data class ListAllGroupMembersRequest(
    val project: String,
    val group: String,
)

Properties

---

ListGroupMembersRequest

data class ListGroupMembersRequest(
    val group: String,
    val itemsPerPage: Int?,
    val page: Int?,
)

Properties

---

ListGroupsWithSummaryRequest

data class ListGroupsWithSummaryRequest(
    val itemsPerPage: Int?,
    val page: Int?,
)

Properties

---

LookupByGroupTitleRequest

data class LookupByGroupTitleRequest(
    val projectId: String,
    val title: String,
)

Properties

---

LookupProjectAndGroupRequest

data class LookupProjectAndGroupRequest(
    val project: String,
    val group: String,
)

Properties

---

RemoveGroupMemberRequest

data class RemoveGroupMemberRequest(
    val group: String,
    val memberUsername: String,
)

Properties

---

UpdateGroupNameRequest

data class UpdateGroupNameRequest(
    val groupId: String,
    val newGroupName: String,
)

Properties

---

ViewGroupRequest

data class ViewGroupRequest(
    val id: String,
)

Properties

---

GroupExistsResponse

data class GroupExistsResponse(
    val exists: List<Boolean>,
)

Properties

---

IsMemberResponse

data class IsMemberResponse(
    val responses: List<Boolean>,
)

Properties

---

ListAllGroupIdsAndTitlesResponse

data class ListAllGroupIdsAndTitlesResponse(
    val groups: JsonObject,
)

Properties

---