fyi.opensocial.provisionGroup
Host-level: an app creates a group for a person and gets its own OAuth session on it. Authenticated twice: the person asking, by service auth from their PDS (they become the founder), and the app, by OAuth client authentication in the body (a client assertion for a confidential client) with a DPoP proof in the `DPoP` header, exactly as at the token endpoint. The app must be one this host provisions for. Returns the group and a token response bound to the proof's key, issued to the app's client id: refreshed, listed and revoked like any other session on the group.
Details · procedure
| Kind | procedure |
|---|---|
| Authority | opensocial.fyi |
| Indexed |
Showing version bafyreiaeuvabxfgip7yqk5wx3cvdcpj3xyya5efmxpxomhfa3whzljh7ea. Show the latest
Checks
Validunlimited-stringdefs.main.input.schema.properties.joinPolicyNo maxLength, maxGraphemes or format limits this string.
{
"$type": "com.atproto.lexicon.schema",
"defs": {
"main": {
"description": "Host-level: an app creates a group for a person and gets its own OAuth session on it. Authenticated twice: the person asking, by service auth from their PDS (they become the founder), and the app, by OAuth client authentication in the body (a client assertion for a confidential client) with a DPoP proof in the `DPoP` header, exactly as at the token endpoint. The app must be one this host provisions for. Returns the group and a token response bound to the proof's key, issued to the app's client id: refreshed, listed and revoked like any other session on the group.",
"errors": [
{
"name": "UntrustedApp"
},
{
"name": "InvalidScope"
},
{
"name": "use_dpop_nonce"
},
{
"name": "HandleTaken"
}
],
"input": {
"encoding": "application/json",
"schema": {
"properties": {
"clientAssertion": {
"maxLength": 8192,
"type": "string"
},
"clientAssertionType": {
"maxLength": 256,
"type": "string"
},
"clientId": {
"description": "The app's OAuth client id, its client metadata's URL.",
"maxLength": 2048,
"type": "string"
},
"description": {
"maxGraphemes": 300,
"maxLength": 3000,
"type": "string"
},
"displayName": {
"maxGraphemes": 64,
"maxLength": 640,
"type": "string"
},
"handle": {
"format": "handle",
"type": "string"
},
"joinPolicy": {
"knownValues": [
"fyi.opensocial.profile#open",
"fyi.opensocial.profile#request",
"fyi.opensocial.profile#invite"
],
"type": "string"
},
"metaReadableBy": {
"items": {
"ref": "fyi.opensocial.defs#audience",
"type": "ref"
},
"type": "array"
},
"scope": {
"description": "The OAuth scope the app wants on the group. Must include `atproto`, and every entry must be one the app's client metadata declares.",
"maxLength": 2048,
"type": "string"
},
"stewards": {
"description": "Accounts that run the group alongside the founder.",
"items": {
"ref": "fyi.opensocial.defs#accountRef",
"type": "ref"
},
"type": "array"
}
},
"required": [
"handle",
"displayName",
"scope",
"clientId"
],
"type": "object"
}
},
"output": {
"encoding": "application/json",
"schema": {
"properties": {
"did": {
"format": "did",
"type": "string"
},
"members": {
"format": "space-ref",
"type": "string"
},
"meta": {
"format": "space-ref",
"type": "string"
},
"session": {
"description": "An OAuth token response (access_token, token_type, refresh_token, expires_in, scope, sub), as /oauth/token returns it.",
"type": "unknown"
}
},
"required": [
"did",
"meta",
"members",
"session"
],
"type": "object"
}
},
"type": "procedure"
}
},
"id": "fyi.opensocial.provisionGroup",
"lexicon": 1
}