social.colibri.beta.actor.grantSpaceAccess

Hands the AppView access to one of the requesting user's personal spaces. The client mints a delegation token on its own PDS for the space and passes it here, because a delegation token is single-use and short-lived and the AppView has no OAuth session of its own. The AppView exchanges the token for a space credential and syncs the space.

Repository @colibri.social did:plc:mprdjqjluoswa7awzggaggj3 namespace authority
Details · procedure
Kindprocedure
Authorityactor.beta.colibri.social
Indexed
cid bafyreibl4mungi3jhoqlu2jfcaeyaxfpkwrk77ejfob5wldyrpe4u3nbmu

Checks

Valid
  • unlimited-string defs.main.input.schema.properties.delegationTokenNo maxLength, maxGraphemes or format limits this string.
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Hands the AppView access to one of the requesting user's personal spaces. The client mints a delegation token on its own PDS for the space and passes it here, because a delegation token is single-use and short-lived and the AppView has no OAuth session of its own. The AppView exchanges the token for a space credential and syncs the space.",
      "errors": [
        {
          "description": "The request has no valid service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "The arguments are inconsistent or malformed beyond schema validation.",
          "name": "InvalidRequest"
        },
        {
          "description": "The delegation token is malformed, expired, or already used.",
          "name": "InvalidDelegationToken"
        },
        {
          "description": "No space matches the given space reference.",
          "name": "SpaceNotFound"
        },
        {
          "description": "The delegation token does not grant access to the given space.",
          "name": "NotAuthorized"
        },
        {
          "description": "The user's PDS failed while the AppView exchanged the delegation token or synced the space.",
          "name": "UpstreamFailure"
        }
      ],
      "input": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "delegationToken": {
              "description": "A delegation token minted by the user's PDS for the space.",
              "type": "string"
            },
            "space": {
              "description": "The space to grant access to.",
              "format": "space-ref",
              "type": "string"
            }
          },
          "required": [
            "space",
            "delegationToken"
          ],
          "type": "object"
        }
      },
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "expiresAt": {
              "description": "When the resulting space credential expires. The client should call this again before then to keep access current.",
              "format": "datetime",
              "type": "string"
            }
          },
          "required": [
            "expiresAt"
          ],
          "type": "object"
        }
      },
      "type": "procedure"
    }
  },
  "id": "social.colibri.beta.actor.grantSpaceAccess",
  "lexicon": 1
}