fyi.opensocial.putRole

lexicons.opensocial.fyi

Documentation

Create or update a role and its action bindings. Requires group.configure.

main procedure

Create or update a role and its action bindings. Requires group.configure.

Input

Encodingapplication/json
actions array Required

No description available.

assignable array Optional

No description available.

description string Optional

No description available.

group stringdid Required

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

name string Required

No description available.

repoCollections array Optional

See fyi.opensocial.permissions#binding. Omitted keeps the role's current value.

role string Required

No description available.

maxLength: 64 bytes

Output

Encodingapplication/json
cid stringcid Required

A content identifier (CID) referencing immutable data.

uri stringat-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Base URL for XRPC calls (e.g., https://bsky.social)
Enter valid JSON for the request body
View raw schema 
{
  "description": "Create or update a role and its action bindings. Requires group.configure.",
  "input": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "actions": {
          "items": {
            "ref": "fyi.opensocial.permissions#action",
            "type": "ref"
          },
          "type": "array"
        },
        "assignable": {
          "items": {
            "maxLength": 64,
            "type": "string"
          },
          "type": "array"
        },
        "description": {
          "type": "string"
        },
        "group": {
          "description": "The group DID. Every method is served by the group's host and authorized against that group's roles.",
          "format": "did",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "repoCollections": {
          "description": "See fyi.opensocial.permissions#binding. Omitted keeps the role's current value.",
          "items": {
            "type": "string"
          },
          "type": "array"
        },
        "role": {
          "maxLength": 64,
          "type": "string"
        }
      },
      "required": [
        "group",
        "role",
        "name",
        "actions"
      ],
      "type": "object"
    }
  },
  "output": {
    "encoding": "application/json",
    "schema": {
      "properties": {
        "cid": {
          "format": "cid",
          "type": "string"
        },
        "uri": {
          "format": "at-uri",
          "type": "string"
        }
      },
      "required": [
        "uri",
        "cid"
      ],
      "type": "object"
    }
  },
  "type": "procedure"
}

Lexicon Garden

@