Groups

API: Internal/Beta

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
Name Description
count No description
groupExists No description
isMember No description
listAllGroupIdsAndTitles No description
listGroupMembers No description
listGroupsWithSummary No description
lookupByTitle No description
lookupProjectAndGroup No description
view No description
addGroupMember No description
create No description
delete No description
listAllGroupMembers No description
removeGroupMember No description
updateGroupName No description
2. Data Models
Name Description
GroupWithSummary No description
IsMemberQuery No description
ProjectAndGroup No description
ProjectGroup No description
AddGroupMemberRequest No description
CreateGroupRequest No description
DeleteGroupsRequest No description
GroupExistsRequest No description
IsMemberRequest No description
ListAllGroupMembersRequest No description
ListGroupMembersRequest No description
ListGroupsWithSummaryRequest No description
LookupByGroupTitleRequest No description
LookupProjectAndGroupRequest No description
RemoveGroupMemberRequest No description
UpdateGroupNameRequest No description
ViewGroupRequest No description
GroupExistsResponse No description
IsMemberResponse No description
ListAllGroupIdsAndTitlesResponse No description

Remote Procedure Calls

count

API: Internal/Beta Auth: Users

Request Response Error
Unit Long CommonErrorMessage

groupExists

API: Internal/Beta Auth: Services

Request Response Error
GroupExistsRequest GroupExistsResponse CommonErrorMessage

isMember

API: Internal/Beta Auth: Services

Request Response Error
IsMemberRequest IsMemberResponse CommonErrorMessage

listAllGroupIdsAndTitles

API: Internal/Beta Auth: Authenticated

Request Response Error
Unit ListAllGroupIdsAndTitlesResponse CommonErrorMessage

listGroupMembers

API: Internal/Beta Auth: Users

Request Response Error
ListGroupMembersRequest Page<String> CommonErrorMessage

listGroupsWithSummary

API: Internal/Beta Auth: Users

Request Response Error
ListGroupsWithSummaryRequest Page<GroupWithSummary> CommonErrorMessage

lookupByTitle

API: Internal/Beta Auth: Services

Request Response Error
LookupByGroupTitleRequest GroupWithSummary CommonErrorMessage

lookupProjectAndGroup

API: Internal/Beta Auth: Services

Request Response Error
LookupProjectAndGroupRequest ProjectAndGroup CommonErrorMessage

view

API: Internal/Beta Auth: Users

Request Response Error
ViewGroupRequest GroupWithSummary CommonErrorMessage

addGroupMember

API: Internal/Beta Auth: Users

Request Response Error
AddGroupMemberRequest Unit CommonErrorMessage

create

API: Internal/Beta Auth: Users

Request Response Error
CreateGroupRequest FindByStringId CommonErrorMessage

delete

API: Internal/Beta Auth: Users

Request Response Error
DeleteGroupsRequest Unit CommonErrorMessage

listAllGroupMembers

API: Internal/Beta Auth: Services

Request Response Error
ListAllGroupMembersRequest List<String> CommonErrorMessage

removeGroupMember

API: Internal/Beta Auth: Users

Request Response Error
RemoveGroupMemberRequest Unit CommonErrorMessage

updateGroupName

API: Internal/Beta Auth: Users

Request Response Error
UpdateGroupNameRequest Unit CommonErrorMessage

Data Models

GroupWithSummary

API: Internal/Beta

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

IsMemberQuery

API: Internal/Beta

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

ProjectAndGroup

API: Internal/Beta

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

ProjectGroup

API: Internal/Beta

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

AddGroupMemberRequest

API: Internal/Beta

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

CreateGroupRequest

API: Internal/Beta

data class CreateGroupRequest(
    val group: String,
)
Properties
group: String

DeleteGroupsRequest

API: Internal/Beta

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

GroupExistsRequest

API: Internal/Beta

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

IsMemberRequest

API: Internal/Beta

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

ListAllGroupMembersRequest

API: Internal/Beta

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

ListGroupMembersRequest

API: Internal/Beta

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

ListGroupsWithSummaryRequest

API: Internal/Beta

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

LookupByGroupTitleRequest

API: Internal/Beta

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

LookupProjectAndGroupRequest

API: Internal/Beta

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

RemoveGroupMemberRequest

API: Internal/Beta

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

UpdateGroupNameRequest

API: Internal/Beta

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

ViewGroupRequest

API: Internal/Beta

data class ViewGroupRequest(
    val id: String,
)
Properties
id: String

GroupExistsResponse

API: Internal/Beta

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

IsMemberResponse

API: Internal/Beta

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

ListAllGroupIdsAndTitlesResponse

API: Internal/Beta

data class ListAllGroupIdsAndTitlesResponse(
    val groups: JsonObject,
)
Properties
groups: JsonObject