Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions docs/auth/authentication/using-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -134,17 +134,23 @@ Pass `--expires-in <seconds>` to request a specific finite lifetime. Pass
`--expires-in none` only for deployments where the administrator has explicitly
allowed unlimited keys.

List keys or revoke one by its stable `jti`:
List keys, temporarily suspend and restore one, or permanently revoke one by its stable `jti`:

```bash
nemo auth access-keys list
nemo auth access-keys list --page 2 --page-size 100
nemo auth access-keys suspend ak_0123456789abcdef0123456789abcdef
nemo auth access-keys unsuspend ak_0123456789abcdef0123456789abcdef
nemo auth access-keys revoke ak_0123456789abcdef0123456789abcdef
```

The list includes each key's `ACTIVE`, `EXPIRED`, or `REVOKED` status plus its
description, issuer, audiences, creation time, and expiration time. Revocation takes
effect on subsequent authenticated platform requests. Rotation is not implemented.
The list includes each key's `ACTIVE`, `EXPIRED`, `SUSPENDED`, or `REVOKED` status
plus its description, issuer, audiences, creation time, and expiration time. Suspension
and revocation take effect on subsequent authenticated platform requests. Use suspension
to temporarily block a key, such as while investigating suspected misuse, without
permanently revoking it. An unexpired suspended key can be restored with `unsuspend`. If
the key expires while suspended, `unsuspend` is a no-op and reports `EXPIRED`. A revoked
key cannot be restored. Rotation is not implemented.

### Token Inspection

Expand Down
40 changes: 40 additions & 0 deletions docs/cli/reference.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -281,6 +281,8 @@ nemo auth access-keys [OPTIONS] COMMAND [ARGS]...
* `create`: Create a Scoped Access Key for the currently...
* `list`: List Scoped Access Keys owned by the currently...
* `revoke`: Revoke a Scoped Access Key owned by the currently...
* `suspend`: Temporarily suspend a Scoped Access Key owned by the...
* `unsuspend`: Restore a suspended Scoped Access Key owned by the...

##### nemo auth access-keys create

Expand Down Expand Up @@ -339,6 +341,44 @@ nemo auth access-keys revoke [OPTIONS] JTI

* `--help, -h`: Show this message and exit.

##### nemo auth access-keys suspend
Comment thread
anastasia-nesterenko marked this conversation as resolved.

Temporarily suspend a Scoped Access Key owned by the current user.

Unlike revocation, suspension is reversible until the key expires.

**Usage:**

```shell
nemo auth access-keys suspend [OPTIONS] JTI
```

**Arguments:**

* `<JTI>`: Stable ID of the Scoped Access Key to suspend.

**Help:**

* `--help, -h`: Show this message and exit.

##### nemo auth access-keys unsuspend

Restore a suspended Scoped Access Key owned by the current user.

**Usage:**

```shell
nemo auth access-keys unsuspend [OPTIONS] JTI
```

**Arguments:**

* `<JTI>`: Stable ID of the Scoped Access Key to unsuspend.

**Help:**

* `--help, -h`: Show this message and exit.

### nemo services

Run platform services locally.
Expand Down
125 changes: 123 additions & 2 deletions openapi/ga/individual/platform.openapi.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Loading
Loading