Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

EDB-2308: EdgeKV Token Workflow changes #154

Merged
merged 3 commits into from
Sep 4, 2024
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
2 changes: 1 addition & 1 deletion .github/workflows/pullRequestBuildTest.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:

strategy:
matrix:
node-version: [16.x]
node-version: [20.x]

steps:
- uses: actions/checkout@v3
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/pullRequestLint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ jobs:

strategy:
matrix:
node-version: [16.x]
node-version: [20.x]

steps:
- uses: actions/checkout@v3
Expand Down
2 changes: 1 addition & 1 deletion cli.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
},
{
"name": "edgekv",
"version": "1.8.1",
"version": "1.9.0",
"aliases": ["ekv", "edgekv"],
"description": "Manage Akamai EdgeKV database."
}
Expand Down
18 changes: 15 additions & 3 deletions docs/edgekv_cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@
* [ List Items](###list-items)
* [ Create an Access Token](###create-an-access-token)
* [ List Access Tokens](###list-access-tokens)
* [ Refresh Access Token](###refresh-access-token)
* [ Retrieve Access Token](###retrieve-access-token)
* [ Revoke access token](###revoke-access-token)
* [ List permission groups](###list-permission-groups)
Expand Down Expand Up @@ -393,7 +394,7 @@ Example:
| -- production | Required | Acceptable value: 'allow', 'deny'. <br />Specifies whether the token will be allowed or denied in the production environment. |
| -- ewids | Required | Acceptable value: <br /> - 'all', <br /> - A comma separated list of up to a maximum of 8 EdgeWorker IDs. This restricts token usage to the specified EdgeWorker IDs. |
| --namespace | Required | Value: A comma separated list of up to a maximum of 20 namespace identifier and permission combinations. This list specifies where the token can be used. The permissions format is any combination of the following letters: <br /> - 'r' to authorize the token for read operations <br /> - 'w' to authorize the token for write operations <br /> - 'd' to authorize the token for delete operations. <br /> Example: "myNamespace1+rwd,myNamespace2+rw" |
| --expiry | Required | Expiration date of the token. Format of the expiry date is ISO 8601 format: yyyy-mm-dd. |
| --expiry | Optional | Expiration date of the token. Format of the expiry date is ISO 8601 format: yyyy-mm-dd. Optional for Enhanced Token Workflow. |
| -h, --help | Optional | Display information on how to use this EdgeKV command. |

| Argument | Existence | Description |
Expand All @@ -418,7 +419,18 @@ Usage: `akamai edgekv list tokens`

#### Important Notes
1. Note that --include-expired returns all the tokens that count towards your account's token limit. For more details, See [Akamai EdgeKV getting started guide](https://techdocs.akamai.com/edgekv/docs/limits)


### Refresh Access Token

Refreshes an EdgeKV Enhanced Token Workflow access token.

Usage:
`akamai edgekv refresh token <tokenName>`

| Argument | Existence | Description |
| - | - | - |
| tokenName | required | token name |

### Retrieve Access Token

Retrieve an EdgeKV access token.
Expand All @@ -438,7 +450,7 @@ Usage:

### Revoke Access Token

Revoke an EdgKV access token.
Revoke an EdgeKV access token.

Usage:
`akamai edgekv revoke token <tokenName>`
Expand Down
Loading
Loading