# Read your account's sign-in security

> Page: https://docs.plotwork.dev/api/get-user-security. Index of every page: https://docs.plotwork.dev/llms.txt

Whether two-step sign-in is on, since when, how many recovery codes are left, and which organisations you are in that require it.

`GET /user/security`

## TL;DR

| Question | Answer |
|---|---|
| What does it do? | Read your account's sign-in security. |
| What does it take? | Nothing. |
| What does it return? | Status 200 with a body of type [`Security`](https://docs.plotwork.dev/api/schemas.md#security). |
| What can go wrong? | `401` not signed in; `429` too many requests. Every failure uses the one error envelope. |

## What it does

Whether two-step sign-in is on, since when, how many recovery codes are left, and which organisations you are in that require it.

## Responses

| Status | Meaning | Body |
|---|---|---|
| 200 | The account's security. | [`Security`](https://docs.plotwork.dev/api/schemas.md#security) |
| 401 | Not signed in. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |
| 429 | Too many requests. | [`ErrorResponse`](https://docs.plotwork.dev/api/schemas.md#errorresponse) |

## Response body

A 200 answer has the type [`Security`](https://docs.plotwork.dev/api/schemas.md#security).

| Field | Type | Required | Description |
|---|---|---|---|
| `twoFactor` | `TwoFactorState` | yes |  |
| `twoFactor.enabled` | `boolean` | yes |  |
| `twoFactor.enabledAt` | `integer \| null` | yes |  |
| `twoFactor.recoveryCodesLeft` | `integer` | yes |  |
| `twoFactor.requiredBy` | `object[]` | yes | The organisations the account is in that require two-step sign-in. |
| `twoFactor.requiredBy[].slug` | `string` | yes |  |
| `twoFactor.requiredBy[].name` | `string` | yes |  |

## See also

| Doc | Why |
|---|---|
| [API reference](https://docs.plotwork.dev/api/reference.md) | Every endpoint, and the error envelope |
| [Schemas](https://docs.plotwork.dev/api/schemas.md) | Every request and response type |
| [Tool reference](https://docs.plotwork.dev/mcp/tools.md) | The operations as callable tools |