fyi.opensocial.getAuthorization

lexicons.opensocial.fyi

Documentation

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.

main query

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.

Parameters

requestUri string Required

The request_uri the app received from this host's pushed authorization request endpoint.

Output

Encodingapplication/json
client ref#client Required

No description available.

groups array Required

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.

labels array Optional

What each permission set the app asked for says it is for, in its own words.

loginHint string Optional

The group the app named, if it named one.

requested array Required

The scope values the app asked for.

Errors

ExpiredRequest
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://api.bsky.social)
Parameters
The request_uri the app received from this host's pushed authorization request endpoint.
View raw schema 
{
  "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"
        },
        "requested": {
          "description": "The scope values the app asked for.",
          "items": {
            "type": "string"
          },
          "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"
}
client object

No description available.

Properties

id string Required

No description available.

name string Optional

No description available.

uri string uri Optional

A valid URI.

View raw schema 
{
  "properties": {
    "id": {
      "type": "string"
    },
    "logo": {
      "format": "uri",
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "uri": {
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "id"
  ],
  "type": "object"
}
group object

No description available.

Properties

avatar string uri Optional

A valid URI.

did string did Required

A decentralized identifier (DID).

displayName string Optional

No description available.

granted array of string Required

The requested scope values the caller's roles let the app have.

handle string Required

No description available.

roles array of string Required

No description available.

withheld array of string Required

The requested scope values the app will not get.

View raw schema 
{
  "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": {
        "type": "string"
      },
      "type": "array"
    },
    "handle": {
      "type": "string"
    },
    "roles": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "withheld": {
      "description": "The requested scope values the app will not get.",
      "items": {
        "type": "string"
      },
      "type": "array"
    }
  },
  "required": [
    "did",
    "handle",
    "roles",
    "granted",
    "withheld"
  ],
  "type": "object"
}
label object

No description available.

Properties

scope string Required

No description available.

text string Required

No description available.

View raw schema 
{
  "properties": {
    "scope": {
      "type": "string"
    },
    "text": {
      "type": "string"
    }
  },
  "required": [
    "scope",
    "text"
  ],
  "type": "object"
}

Lexicon Garden

@