#main - procedureCreate an authentication session.
Query Parameters
No fields defined
Request Body
Content Type: application/json
Data Fields
| Name | Type | Details |
|---|---|---|
allowTakendown |
boolean |
When true, instead of throwing error for takendown accounts, a valid response with a narrow scoped token will be returned |
authFactorToken |
string | |
identifier |
string (required) |
Handle or other identifier supported by the server for the authenticating user. |
password |
string (required) |
Response Body
Content Type: application/json
Data Fields
| Name | Type | Details |
|---|---|---|
accessJwt |
string (required) | |
active |
boolean | |
did |
string (required) |
Syntax Format: |
didDoc |
unknown | Field can contain arbitrary JSON/CBOR object data |
email |
string | |
emailAuthFactor |
boolean | |
emailConfirmed |
boolean | |
handle |
string (required) |
Syntax Format: |
refreshJwt |
string (required) | |
status |
string |
If active=false, this optional field indicates a possible reason for why the account is not active. If active=false and no status is supplied, then the host makes no claim for why the repository is no longer being hosted. Known Values: |
Errors
| Name | Description |
|---|---|
AccountTakedown |
|
AuthFactorTokenRequired |