Removes a member from a community. The member may rejoin unless the community requires approval to join.
Input
Encoding
application/jsoncommunity
stringdid
Required
The community to remove the member from.
reason
string
Optional
Human-readable reason for the kick.
maxLength: 512 bytessubject
stringdid
Required
The member to remove.
Output
Encoding
application/jsonErrors
AuthRequired
The request is missing, malformed, or unverifiable service auth. Forbidden
The caller lacks the member.kick permission. CommunityNotFound
No community exists at the given DID. MemberNotFound
The subject does not hold a member record in this community. RoleHierarchy
The subject holds a role at or above the caller's highest role position. CredentialsUnavailable
The AppView cannot act as the community because its stored credentials are missing or unusable. Try It
Requests are sent directly from your browser. Some servers may block requests due to CORS.
View raw schema
{
"type": "procedure",
"input": {
"schema": {
"type": "object",
"required": [
"community",
"subject"
],
"properties": {
"reason": {
"type": "string",
"maxLength": 512,
"description": "Human-readable reason for the kick."
},
"subject": {
"type": "string",
"format": "did",
"description": "The member to remove."
},
"community": {
"type": "string",
"format": "did",
"description": "The community to remove the member from."
}
}
},
"encoding": "application/json"
},
"errors": [
{
"name": "AuthRequired",
"description": "The request is missing, malformed, or unverifiable service auth."
},
{
"name": "Forbidden",
"description": "The caller lacks the member.kick permission."
},
{
"name": "CommunityNotFound",
"description": "No community exists at the given DID."
},
{
"name": "MemberNotFound",
"description": "The subject does not hold a member record in this community."
},
{
"name": "RoleHierarchy",
"description": "The subject holds a role at or above the caller's highest role position."
},
{
"name": "CredentialsUnavailable",
"description": "The AppView cannot act as the community because its stored credentials are missing or unusable."
}
],
"output": {
"schema": {
"type": "object",
"properties": {}
},
"encoding": "application/json"
},
"description": "Removes a member from a community. The member may rejoin unless the community requires approval to join."
}