Members

API: Internal/Beta

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
Name Description
count No description
search No description
userStatus No description
lookupAdmins No description
lookupAdminsBulk No description
2. Data Models
Name Description
Pair No description
UserGroupSummary No description
UserStatusInProject No description
LookupAdminsBulkRequest No description
LookupAdminsRequest No description
SearchRequest No description
UserStatusRequest No description
LookupAdminsBulkResponse No description
LookupAdminsResponse No description
UserStatusResponse No description

Remote Procedure Calls

count

API: Internal/Beta Auth: Users

Request Response Error
Unit Long CommonErrorMessage

userStatus

API: Internal/Beta Auth: Authenticated

Request Response Error
UserStatusRequest UserStatusResponse CommonErrorMessage

lookupAdmins

API: Internal/Beta Auth: Services

Request Response Error
LookupAdminsRequest LookupAdminsResponse CommonErrorMessage

lookupAdminsBulk

API: Internal/Beta Auth: Services

Request Response Error
LookupAdminsBulkRequest LookupAdminsBulkResponse CommonErrorMessage

Data Models

Pair

API: Internal/Beta

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

UserGroupSummary

API: Internal/Beta

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

UserStatusInProject

API: Internal/Beta

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

LookupAdminsBulkRequest

API: Internal/Beta

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

LookupAdminsRequest

API: Internal/Beta

data class LookupAdminsRequest(
    val projectId: String,
)
Properties
projectId: String

SearchRequest

API: Internal/Beta

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

UserStatusRequest

API: Internal/Beta

data class UserStatusRequest(
    val username: String?,
)
Properties
username: String?

LookupAdminsBulkResponse

API: Internal/Beta

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

LookupAdminsResponse

API: Internal/Beta

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

UserStatusResponse

API: Internal/Beta

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