Lexicon Garden

fyi.opensocial.getAuthorization

An app's pending request to sign in as a group, as the caller would approve it: the app, the groups the caller may act for, and for each one what the caller's roles let the app do. Called by the console's approval page, with service auth from the caller's own PDS.

Repository @lexicons.opensocial.fyi did:plc:2gqnilpksz2e7faj3bwvo6qc namespace authority
Details · query
Kindquery
Authorityopensocial.fyi
Indexed
Compare Edit in builder → Fork →
cid bafyreidbviwzwux6eskpfquqexndh3xmroivqt6rz6yq5pkigg2l6v6xei

Checks

Valid
JSONDownload
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "client": {
      "properties": {
        "clientId": {
          "type": "string"
        },
        "logo": {
          "format": "uri",
          "type": "string"
        },
        "name": {
          "type": "string"
        },
        "uri": {
          "format": "uri",
          "type": "string"
        }
      },
      "required": [
        "clientId"
      ],
      "type": "object"
    },
    "group": {
      "properties": {
        "avatar": {
          "format": "uri",
          "type": "string"
        },
        "did": {
          "format": "did",
          "type": "string"
        },
        "displayName": {
          "type": "string"
        },
        "granted": {
          "description": "The requested scope values the caller's roles let the app have.",
          "items": {
            "ref": "fyi.opensocial.defs#scopeRef",
            "type": "ref"
          },
          "type": "array"
        },
        "handle": {
          "type": "string"
        },
        "roles": {
          "items": {
            "ref": "fyi.opensocial.defs#roleRef",
            "type": "ref"
          },
          "type": "array"
        },
        "withheld": {
          "description": "The requested scope values the app will not get.",
          "items": {
            "ref": "fyi.opensocial.defs#scopeRef",
            "type": "ref"
          },
          "type": "array"
        }
      },
      "required": [
        "did",
        "handle",
        "roles",
        "granted",
        "withheld"
      ],
      "type": "object"
    },
    "label": {
      "properties": {
        "scope": {
          "type": "string"
        },
        "text": {
          "type": "string"
        }
      },
      "required": [
        "scope",
        "text"
      ],
      "type": "object"
    },
    "main": {
      "description": "An app's pending request to sign in as a group, as the caller would approve it: the app, the groups the caller may act for, and for each one what the caller's roles let the app do. Called by the console's approval page, with service auth from the caller's own PDS.",
      "errors": [
        {
          "name": "ExpiredRequest"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "client": {
              "ref": "#client",
              "type": "ref"
            },
            "groups": {
              "description": "The groups the caller may sign in as: the one the app named, or every group on this host where the caller holds a role.",
              "items": {
                "ref": "#group",
                "type": "ref"
              },
              "type": "array"
            },
            "labels": {
              "description": "What each permission set the app asked for says it is for, in its own words.",
              "items": {
                "ref": "#label",
                "type": "ref"
              },
              "type": "array"
            },
            "loginHint": {
              "description": "The group the app named, if it named one.",
              "type": "string"
            },
            "mcp": {
              "description": "Whether the app is an MCP client, an AI app, asking to act as the caller in a group through the host's MCP tools rather than to sign in as one. It asks for no scope: it may do what the caller's roles in the group allow.",
              "type": "boolean"
            },
            "requested": {
              "description": "The scope values the app asked for.",
              "items": {
                "ref": "fyi.opensocial.defs#scopeRef",
                "type": "ref"
              },
              "type": "array"
            }
          },
          "required": [
            "client",
            "groups",
            "requested"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "requestUri": {
            "description": "The request_uri the app received from this host's pushed authorization request endpoint.",
            "type": "string"
          }
        },
        "required": [
          "requestUri"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "fyi.opensocial.getAuthorization",
  "lexicon": 1
}