Lexicon Garden

fyi.opensocial.putRole

Create or update a role and its grant. Requires group.configure.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · procedure
Kindprocedure
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →

Procedure

procedure · POST

Input

application/json

actions

requiredarray

What the role may do. Written as the scopes that grant each, beside any other scope the role already holds.

itemsref
Reference

assignable

array
itemsstring
  • maxLength: 64

bot

boolean

Whether people with this role are bots: accounts that act on their own, not a person. Giving someone a bot role is how they are marked as one.

default

boolean

Whether members get this role when they join. Omitted keeps the role's current value.

description

string

group

requiredstring · did

The group DID. Every method is served by the group's host and authorized against that group's roles.

name

requiredstring

What the role is called. Written as the role record's displayName.

repoCollections

array

Collections holders may write in the group's public repo as the group, `*` for any; written as `repo:` scopes. Omitted keeps the role's current value.

itemsstring

role

requiredstring
  • maxLength: 64

Output

application/json

cid

requiredstring · cid

uri

requiredstring · at-uri

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • fyi.opensocial.role

    record

    Declares that a role exists, in the members space. The record key is the role id, of 64 characters at most. A role is deleted only once no member holds it and the permissions record grants it nothing.

  • fyi.opensocial.assignRoles

    procedure

    Set a member's full role set. Requires role.assign; every role added or removed must be in the caller's assignable set.

  • fyi.opensocial.permissions

    record

    Group-wide grants for each role, in the members space: the OAuth scopes the role holds and the roles its holders may assign. Roles compose by union; there are no deny rules. A writer changes the grants only of roles they may assign, adds no scope their own roles do not hold, and lets no role assign one they may not.

  • social.colibri.beta.role.create

    procedure

    Creates a role in a community.

  • social.colibri.beta.role.update

    procedure

    Updates a role's settings.