social.colibri.beta.role.create
Creates a role in a community.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | role.beta.colibri.social |
| Indexed |
Showing version bafyreia62at463nwm2to45fsfaxz2wv7fk3syy3ukv2zrnhanzppcg42he. Show the latest
Procedure
procedure · POSTInput
application/jsonbadge
refAn icon badge. Image badges are set with social.colibri.beta.role.putBadgeImage.
color
stringHex colour as #rrggbb.
maxLength: 7
The community to create the role in.
hoisted
booleanWhether holders are listed separately in the member list.
mentionable
booleanWhether @role mentions resolve to this role.
Display name.
minLength: 1maxLength: 32
Permissions granted by this role.
A namespaced permission identifier.
position
integerHierarchy position. Higher outranks lower.
Output
application/jsonThe newly created role.
Errors
AuthRequired
The request is missing, malformed, or unverifiable service auth.
Forbidden
The caller lacks the role.manage permission.
CommunityNotFound
No community exists at the given DID.
InvalidRequest
The arguments are inconsistent or malformed beyond schema validation.
RoleHierarchy
The requested position is at or above the caller's highest role position, or the permissions include one the caller does not hold.
CredentialsUnavailable
The AppView cannot act as the community because its stored credentials are missing or unusable.
Similar lexicons
semantic matchLexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.
-
Creates a role in a community.
-
social.colibri.beta.role.update
procedureUpdates a role's settings.
-
social.colibri.beta.role
recordA named bundle of permissions assignable to community members.
-
Updates a role.
-
com.getorbyt.community.saveRole
procedureCreates a Community role, or changes one. Without a key it creates a role; with one it replaces that role's name and permissions. The key moderator changes what the built-in moderator role may do, and keeps its name. Only an administrator may define roles. Recorded in the moderation log.