atproto blogging
at main 112 lines 3.1 kB view raw
1{ 2 "lexicon": 1, 3 "id": "com.atproto.server.createAccount", 4 "defs": { 5 "main": { 6 "type": "procedure", 7 "description": "Create an account. Implemented by PDS.", 8 "input": { 9 "encoding": "application/json", 10 "schema": { 11 "type": "object", 12 "required": [ 13 "handle" 14 ], 15 "properties": { 16 "did": { 17 "type": "string", 18 "description": "Pre-existing atproto DID, being imported to a new account.", 19 "format": "did" 20 }, 21 "email": { 22 "type": "string" 23 }, 24 "handle": { 25 "type": "string", 26 "description": "Requested handle for the account.", 27 "format": "handle" 28 }, 29 "inviteCode": { 30 "type": "string" 31 }, 32 "password": { 33 "type": "string", 34 "description": "Initial account password. May need to meet instance-specific password strength requirements." 35 }, 36 "plcOp": { 37 "type": "unknown", 38 "description": "A signed DID PLC operation to be submitted as part of importing an existing account to this instance. NOTE: this optional field may be updated when full account migration is implemented." 39 }, 40 "recoveryKey": { 41 "type": "string", 42 "description": "DID PLC rotation key (aka, recovery key) to be included in PLC creation operation." 43 }, 44 "verificationCode": { 45 "type": "string" 46 }, 47 "verificationPhone": { 48 "type": "string" 49 } 50 } 51 } 52 }, 53 "output": { 54 "encoding": "application/json", 55 "schema": { 56 "type": "object", 57 "description": "Account login session returned on successful account creation.", 58 "required": [ 59 "accessJwt", 60 "refreshJwt", 61 "handle", 62 "did" 63 ], 64 "properties": { 65 "accessJwt": { 66 "type": "string" 67 }, 68 "did": { 69 "type": "string", 70 "description": "The DID of the new account.", 71 "format": "did" 72 }, 73 "didDoc": { 74 "type": "unknown", 75 "description": "Complete DID document." 76 }, 77 "handle": { 78 "type": "string", 79 "format": "handle" 80 }, 81 "refreshJwt": { 82 "type": "string" 83 } 84 } 85 } 86 }, 87 "errors": [ 88 { 89 "name": "InvalidHandle" 90 }, 91 { 92 "name": "InvalidPassword" 93 }, 94 { 95 "name": "InvalidInviteCode" 96 }, 97 { 98 "name": "HandleNotAvailable" 99 }, 100 { 101 "name": "UnsupportedDomain" 102 }, 103 { 104 "name": "UnresolvableDid" 105 }, 106 { 107 "name": "IncompatibleDidDoc" 108 } 109 ] 110 } 111 } 112}