# `OAuthScope`

One permission an OAuth token grants: `todos:read`.

Use it to list what a token may do. It holds one scope, so a token's several scopes are a list of these.

## Shape

One value, held as text in one set form, with no parts: `https://www.googleapis.com/auth/userinfo.email`.

## Example

```jadpo
OAuthScope("todos:read")
```

`OAuthScope(raw)` checks the text, and text that isn't one breaks the `format` rule.

`text.parse(raw, as: OAuthScope)` reads one from text that comes from outside. Text that isn't one at all fails `malformed`, such as `openid email`, `say"hi"` or `back\slash`.

## Good to know

- A space is refused, since it separates scopes.
- `==` tells you whether two are the same. `<` and `list.sort_by` don't take it.

## In JSON

A string, in a request, a response or `json.write`:

```json
"openid"
"profile:read"
"https://www.googleapis.com/auth/userinfo.email"
```

## Details

<details>
<summary>Text form, storage, how it is shown, and operations</summary>

`OAuthScope` is in the group Security, and has been in Jadpo since 0.1.0.

### Text form

`text.from` writes one standard text form, the same form `text.parse` reads back: `openid`, `profile:read` and `https://www.googleapis.com/auth/userinfo.email`.

### How it is stored

It is stored in one column named for the field, of type `text`. `profile:read` is stored as `'profile:read'`.

### How it is shown to people

`text.format(value, locale:)` shows it to people in their locale.

With `locale: Locale.en_gb`:

| Value | Shown |
|---|---|
| `openid` | `openid` |
| `profile:read` | `profile:read` |
| `https://www.googleapis.com/auth/userinfo.email` | `https://www.googleapis.com/auth/userinfo.email` |

### Operations

It also takes `text.parse`, `text.from`, `text.format`, `json.read`, `json.write` and `==`. [How every standard type behaves](/docs/every-standard-type-meets-one-contract.md) says how they work.

</details>