Lexicon Garden

fyi.opensocial.checkGroupHandle

Whether a domain is ready to be the group's handle: what its _atproto DNS record, or its /.well-known/atproto-did, names now. Changes nothing. Requires group.configure.

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

Query

query · GET

Parameters

query string

group

requiredstring · did

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

handle

requiredstring

The domain to check, such as riders.org.

Output

application/json

did

string · did

The DID the domain names now, if any: another one means its record is wrong.

handle

requiredstring · handle

The domain, as the host reads it: lower case, with no @.

ready

requiredboolean

Whether updateGroupHandle would take it now: the domain names this group, or it is the group's own address.

Errors

InvalidHandle

No description in schema.

UnsupportedDomain

No description in schema.

HandleNotAvailable

No description in schema.

Similar lexicons

semantic match

Lexicons whose schemas describe something close to this one. Check them before publishing a new one that overlaps.

  • fyi.opensocial.updateGroupHandle

    procedure

    Give the group a handle on a domain it owns, once that domain names the group by its _atproto DNS record or its /.well-known/atproto-did; or give it back its own address as its handle. Updates the group's did:plc and tells the network. Its address stays reserved for it. Requires group.configure.

  • fyi.opensocial.checkAddress

    query

    Whether an address under this host's domain is free for a new group: no account's handle here, nor kept by a group as its address after it took a handle of its own. Anyone may ask, as anyone may resolve a handle.

  • social.grain.unspecced.getGroupHost

    query not from the namespace authority

    The group host this Grain creates groups on, and the domain a new group's handle ends in. Absent when this Grain creates none.