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

feat: FTL-14487 add commands to manage Iota configs #399

Merged
merged 1 commit into from
Aug 19, 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: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -256,12 +256,14 @@ When you run `affinidi stop` your session information is deleted.
* [`affinidi generate`](docs/generate.md) - Use these commands to generate code to get started or to scaffold your solution
* [`affinidi help`](docs/help.md) - Display help for affinidi.
* [`affinidi iam`](docs/iam.md) - Use these commands to manage policies for access configuration
* [`affinidi iota`](docs/iota.md) - Use these commands to manage Iota configurations
* [`affinidi login`](docs/login.md) - Use these commands for user login configuration and group management
* [`affinidi project`](docs/project.md) - Use these commands to manage your projects
* [`affinidi search`](docs/search.md) - Search for a command.
* [`affinidi start`](docs/start.md) - Log in to Affinidi
* [`affinidi stop`](docs/stop.md) - Log out from Affinidi
* [`affinidi token`](docs/token.md) - Use these commands for Personal Access Token (PAT) management
* [`affinidi wallet`](docs/wallet.md) - Use these commands to manage your wallets
* [`affinidi whoami`](docs/whoami.md) - Returns user's subject, projects, and token details from the current session.

<!-- commandsstop -->
Expand Down
2 changes: 1 addition & 1 deletion docs/generate.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,4 +34,4 @@ EXAMPLES
$ affinidi generate app --path "../my-app" --framework django --provider affinidi --force
```

_See code: [src/commands/generate/app.ts](https://github.com/affinidi/affinidi-cli/blob/v2.7.0/src/commands/generate/app.ts)_
_See code: [src/commands/generate/app.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/generate/app.ts)_
10 changes: 5 additions & 5 deletions docs/iam.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ FLAG DESCRIPTIONS
Get a list of possible IDs with command affinidi token list-tokens
```

_See code: [src/commands/iam/add-principal.ts](https://github.com/affinidi/affinidi-cli/blob/v2.7.0/src/commands/iam/add-principal.ts)_
_See code: [src/commands/iam/add-principal.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iam/add-principal.ts)_

## `affinidi iam get-policies`

Expand Down Expand Up @@ -82,7 +82,7 @@ FLAG DESCRIPTIONS
Get a list of possible IDs with command affinidi token list-tokens
```

_See code: [src/commands/iam/get-policies.ts](https://github.com/affinidi/affinidi-cli/blob/v2.7.0/src/commands/iam/get-policies.ts)_
_See code: [src/commands/iam/get-policies.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iam/get-policies.ts)_

## `affinidi iam list-principals`

Expand All @@ -106,7 +106,7 @@ EXAMPLES
$ affinidi iam list-principals
```

_See code: [src/commands/iam/list-principals.ts](https://github.com/affinidi/affinidi-cli/blob/v2.7.0/src/commands/iam/list-principals.ts)_
_See code: [src/commands/iam/list-principals.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iam/list-principals.ts)_

## `affinidi iam remove-principal`

Expand Down Expand Up @@ -143,7 +143,7 @@ FLAG DESCRIPTIONS
Get a list of possible IDs with command affinidi token list-tokens
```

_See code: [src/commands/iam/remove-principal.ts](https://github.com/affinidi/affinidi-cli/blob/v2.7.0/src/commands/iam/remove-principal.ts)_
_See code: [src/commands/iam/remove-principal.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iam/remove-principal.ts)_

## `affinidi iam update-policies`

Expand Down Expand Up @@ -182,4 +182,4 @@ FLAG DESCRIPTIONS
Get a list of possible IDs with command affinidi token list-tokens
```

_See code: [src/commands/iam/update-policies.ts](https://github.com/affinidi/affinidi-cli/blob/v2.7.0/src/commands/iam/update-policies.ts)_
_See code: [src/commands/iam/update-policies.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iam/update-policies.ts)_
290 changes: 290 additions & 0 deletions docs/iota.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,290 @@
`affinidi iota`
===============

Use these commands to manage Iota configurations

* [`affinidi iota create-config`](#affinidi-iota-create-config)
* [`affinidi iota create-query`](#affinidi-iota-create-query)
* [`affinidi iota delete-config`](#affinidi-iota-delete-config)
* [`affinidi iota delete-query`](#affinidi-iota-delete-query)
* [`affinidi iota get-config`](#affinidi-iota-get-config)
* [`affinidi iota get-query`](#affinidi-iota-get-query)
* [`affinidi iota list-configs`](#affinidi-iota-list-configs)
* [`affinidi iota list-queries`](#affinidi-iota-list-queries)
* [`affinidi iota update-config`](#affinidi-iota-update-config)
* [`affinidi iota update-query`](#affinidi-iota-update-query)

## `affinidi iota create-config`

Creates Affinidi Iota Framework configuration in your active project

```
USAGE
$ affinidi iota create-config [--json] [--no-color] [--no-input] [-n <value>] [-d
<value>] [-w <value>] [--token-max-age <value>] [--response-webhook-url <value>] [--enable-verification]
[--enable-consent-audit-log] [--client-name <value>] [--client-origin <value>] [--client-logo <value>]

FLAGS
-d, --description=<value> Description of the Affinidi Iota Framework configuration
-n, --name=<value> Name of the Affinidi Iota Framework configuration
-w, --wallet-ari=<value> ARI of the wallet
--client-logo=<value> Application URL of a logo, displayed in the consent page
--client-name=<value> Name, displayed in the consent page
--client-origin=<value> Domain, displayed in the consent page
--enable-consent-audit-log Log consents
--enable-verification Perform verification
--response-webhook-url=<value> Affinidi Iota Framework response webhook URL
--token-max-age=<value> Token expiration time in seconds

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota create-config -n <value> -w <value>

$ affinidi iota create-config --name <value> --wallet-ari <value>

$ affinidi iota create-config --name <value> --wallet-ari <value> --enable-consent-audit-log --enable-verification --token-max-age <value>
```

_See code: [src/commands/iota/create-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/create-config.ts)_

## `affinidi iota create-query`

Creates PEX query for your Affinidi Iota Framework configuration

```
USAGE
$ affinidi iota create-query [--json] [--no-color] [--no-input] [-c <value>] [-n
<value>] [-d <value>] [-f <value>]

FLAGS
-c, --configuration-id=<value> ID of the Affinidi Iota Framework configuration
-d, --description=<value> PEX query description
-f, --file=<value> Location of a json file containing PEX query
-n, --name=<value> PEX query name

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota create-query -c <value> -n <value> -d <value> -f pexQuery.json

$ affinidi iota create-query --configuration-id <value> --name <value> --description <value> --file pexQuery.json
```

_See code: [src/commands/iota/create-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/create-query.ts)_

## `affinidi iota delete-config`

Deletes Affinidi Iota Framework configuration from your active project

```
USAGE
$ affinidi iota delete-config [--json] [--no-color] [--no-input] [-i <value>]

FLAGS
-i, --id=<value> ID of the Affinidi Iota Framework configuration

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota delete-config -i <value>

$ affinidi iota delete-config --id <value>
```

_See code: [src/commands/iota/delete-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/delete-config.ts)_

## `affinidi iota delete-query`

Deletes the PEX query from your Affinidi Iota Framework configuration

```
USAGE
$ affinidi iota delete-query [--json] [--no-color] [--no-input] [-c <value>] [-i
<value>]

FLAGS
-c, --configuration-id=<value> ID of the Affinidi Iota Framework configuration
-i, --query-id=<value> PEX query ID

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota delete-query -c <uuid> -i <uuid>

$ affinidi iota delete-query --configuration-id <uuid> --query-id <uuid>
```

_See code: [src/commands/iota/delete-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/delete-query.ts)_

## `affinidi iota get-config`

Gets the details of the Affinidi Iota Framework configuration in your active project

```
USAGE
$ affinidi iota get-config [--json] [--no-color] [--no-input] [-i <value>]

FLAGS
-i, --id=<value> ID of the Affinidi Iota Framework configuration

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota get-config -i <value>

$ affinidi iota get-config --id <value>
```

_See code: [src/commands/iota/get-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/get-config.ts)_

## `affinidi iota get-query`

Gets the PEX query details for your Affinidi Iota Framework configuration

```
USAGE
$ affinidi iota get-query [--json] [--no-color] [--no-input] [-c <value>] [-i
<value>]

FLAGS
-c, --configuration-id=<value> ID of the Affinidi Iota Framework configuration
-i, --query-id=<value> PEX query ID

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota get-query -c <uuid> -i <uuid>

$ affinidi iota get-query --configuration-id <uuid> --query-id <uuid>
```

_See code: [src/commands/iota/get-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/get-query.ts)_

## `affinidi iota list-configs`

Lists Affinidi Iota Framework configurations in your active project

```
USAGE
$ affinidi iota list-configs [--json] [--no-color] [--no-input]

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota list-configs
```

_See code: [src/commands/iota/list-configs.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/list-configs.ts)_

## `affinidi iota list-queries`

Lists PEX queries for your Affinidi Iota Framework configuration

```
USAGE
$ affinidi iota list-queries [--json] [--no-color] [--no-input] [-c <value>]

FLAGS
-c, --configuration-id=<value> ID of the Affinidi Iota Framework configuration

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota list-queries -c <value>

$ affinidi iota list-queries --configuration-id <value>
```

_See code: [src/commands/iota/list-queries.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/list-queries.ts)_

## `affinidi iota update-config`

Updates Affinidi Iota Framework configuration in your active project

```
USAGE
$ affinidi iota update-config [--json] [--no-color] [--no-input] [-i <value>] [-n
<value>] [-d <value>] [--wallet-ari <value>] [--token-max-age <value>] [--response-webhook-url <value>]
[--enable-verification] [--enable-consent-audit-log] [--client-name <value>] [--client-origin <value>]
[--client-logo <value>]

FLAGS
-d, --description=<value> Description of the Affinidi Iota Framework configuration
-i, --id=<value> ID of the Affinidi Iota Framework configuration
-n, --name=<value> Name of the Affinidi Iota Framework configuration
--client-logo=<value> Application URL of a logo, displayed in the consent page
--client-name=<value> Name, displayed in the consent page
--client-origin=<value> Domain, displayed in the consent page
--enable-consent-audit-log Log consents
--enable-verification Perform verification
--response-webhook-url=<value> Affinidi Iota Framework response webhook URL
--token-max-age=<value> Token expiration time in seconds - integer between 1 and 10
--wallet-ari=<value> ARI of the wallet

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota update-config -i <value>

$ affinidi iota update-config --id <value>
```

_See code: [src/commands/iota/update-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/update-config.ts)_

## `affinidi iota update-query`

Updates PEX query for your Affinidi Iota Framework configuration

```
USAGE
$ affinidi iota update-query [--json] [--no-color] [--no-input] [-c <value>] [-i
<value>] [-d <value>] [-f <value>]

FLAGS
-c, --configuration-id=<value> ID of the Affinidi Iota Framework configuration
-d, --description=<value> PEX query description
-f, --file=<value> Location of a json file containing PEX query
-i, --query-id=<value> PEX query ID

GLOBAL FLAGS
--json Format output as json.
--no-color Disables color in the output. If you have trouble distinguishing colors, consider using this flag.
--no-input Disables all the interactive prompts

EXAMPLES
$ affinidi iota update-query -c <value> -i <value> -d <value> -f pexQuery.json

$ affinidi iota update-query --configuration-id <value> --query-id <value> -d <value> -f pexQuery.json

$ affinidi iota update-query --configuration-id <value> --query-id <value> --description <value> --file pexQuery.json
```

_See code: [src/commands/iota/update-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.8.1/src/commands/iota/update-query.ts)_
Loading
Loading