members

« Previous section Next section »

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

Members

UCloud Projects have one or more members.

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

search

Request	Response	Error
SearchRequest	Page<ProjectMember>	CommonErrorMessage

userStatus

Request	Response	Error
UserStatusRequest	UserStatusResponse	CommonErrorMessage

lookupAdmins

Request	Response	Error
LookupAdminsRequest	LookupAdminsResponse	CommonErrorMessage

lookupAdminsBulk

Request	Response	Error
LookupAdminsBulkRequest	LookupAdminsBulkResponse	CommonErrorMessage

Data Models

Pair

data class Pair<A, B>(
    val first: A,
    val second: B,
)

Properties

---

UserGroupSummary

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

Properties

---

UserStatusInProject

data class UserStatusInProject(
    val projectId: String,
    val title: String,
    val whoami: ProjectMember,
    val parent: String?,
)

Properties

---

LookupAdminsBulkRequest

data class LookupAdminsBulkRequest(
    val projectId: List<String>,
)

Properties

---

LookupAdminsRequest

data class LookupAdminsRequest(
    val projectId: String,
)

Properties

---

SearchRequest

data class SearchRequest(
    val query: String,
    val notInGroup: String?,
    val itemsPerPage: Int?,
    val page: Int?,
)

Properties

---

UserStatusRequest

data class UserStatusRequest(
    val username: String?,
)

Properties

---

LookupAdminsBulkResponse

data class LookupAdminsBulkResponse(
    val admins: List<Pair<String, List<ProjectMember>>>,
)

Properties

---

LookupAdminsResponse

data class LookupAdminsResponse(
    val admins: List<ProjectMember>,
)

Properties

---

UserStatusResponse

data class UserStatusResponse(
    val membership: List<UserStatusInProject>,
    val groups: List<UserGroupSummary>,
)

Properties

---