# social.colibri.beta.community.getHostAuthorization

> Reports the outcome of a sign-in started with authorizeHost. Only the user who started it can read it.

- Kind: query
- Authority: community.beta.colibri.social
- Lexicon: 1
- Published by [colibri.social](https://lexicon.garden/identity/did:plc:mprdjqjluoswa7awzggaggj3), the NSID's authority

## Links

- [Documentation](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.community.getHostAuthorization)
- [Schema JSON](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.community.getHostAuthorization/schema.json)
- [Analytics](https://lexicon.garden/lexicon/did:plc:mprdjqjluoswa7awzggaggj3/social.colibri.beta.community.getHostAuthorization/analytics)

## Query (`social.colibri.beta.community.getHostAuthorization`)

Type: query · GET

### Parameters (query string)

- `request` (string, required): The request returned by authorizeHost.

### Output (application/json)

- `community` (string · did): The adopted or reconnected community, once done.
- `failure` (string): Why the sign-in failed.
  - Constraints: knownValues: cancelled | wrongAccount | spacesUnsupported | alreadyHosts | failed
- `signedInAs` (string): The account the user signed in as, when it was not the expected one.
- `status` (string, required): pending until the user finishes signing in, then done or failed.
  - Constraints: knownValues: pending | done | failed

### Errors

- `AuthRequired`: The request is missing, malformed, or unverifiable service auth.
- `RequestNotFound`: No sign-in with that request exists for the requesting user.

## Schema

```json
{
  "$type": "com.atproto.lexicon.schema",
  "defs": {
    "main": {
      "description": "Reports the outcome of a sign-in started with authorizeHost. Only the user who started it can read it.",
      "errors": [
        {
          "description": "The request is missing, malformed, or unverifiable service auth.",
          "name": "AuthRequired"
        },
        {
          "description": "No sign-in with that request exists for the requesting user.",
          "name": "RequestNotFound"
        }
      ],
      "output": {
        "encoding": "application/json",
        "schema": {
          "properties": {
            "community": {
              "description": "The adopted or reconnected community, once done.",
              "format": "did",
              "type": "string"
            },
            "failure": {
              "description": "Why the sign-in failed.",
              "knownValues": [
                "cancelled",
                "wrongAccount",
                "spacesUnsupported",
                "alreadyHosts",
                "failed"
              ],
              "type": "string"
            },
            "signedInAs": {
              "description": "The account the user signed in as, when it was not the expected one.",
              "type": "string"
            },
            "status": {
              "description": "pending until the user finishes signing in, then done or failed.",
              "knownValues": [
                "pending",
                "done",
                "failed"
              ],
              "type": "string"
            }
          },
          "required": [
            "status"
          ],
          "type": "object"
        }
      },
      "parameters": {
        "properties": {
          "request": {
            "description": "The request returned by authorizeHost.",
            "type": "string"
          }
        },
        "required": [
          "request"
        ],
        "type": "params"
      },
      "type": "query"
    }
  },
  "id": "social.colibri.beta.community.getHostAuthorization",
  "lexicon": 1
}
```