Skip to content

Commit

Permalink
feat: FTL-19213 modify create/update issuance configuration commands …
Browse files Browse the repository at this point in the history
…to handle claimed VCs webhook (#453)
  • Loading branch information
rbrazhnyk authored Feb 20, 2025
1 parent 4dd392c commit 264970a
Show file tree
Hide file tree
Showing 14 changed files with 226 additions and 66 deletions.
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.10.2/src/commands/generate/app.ts)_
_See code: [src/commands/generate/app.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/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.10.2/src/commands/iam/add-principal.ts)_
_See code: [src/commands/iam/add-principal.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/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.10.2/src/commands/iam/get-policies.ts)_
_See code: [src/commands/iam/get-policies.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/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.10.2/src/commands/iam/list-principals.ts)_
_See code: [src/commands/iam/list-principals.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/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.10.2/src/commands/iam/remove-principal.ts)_
_See code: [src/commands/iam/remove-principal.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/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.10.2/src/commands/iam/update-policies.ts)_
_See code: [src/commands/iam/update-policies.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/iam/update-policies.ts)_
28 changes: 14 additions & 14 deletions docs/iota.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ 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>] [-u <value> -m redirect|websocket] [--token-max-age <value>] [--response-webhook-url <value>]
[--enable-verification] [--enable-consent-audit-log] [--client-name <value>] [--client-origin <value>]
[--disable-verification] [--disable-consent-audit-log] [--client-name <value>] [--client-origin <value>]
[--client-logo <value>]
FLAGS
Expand All @@ -35,7 +35,7 @@ FLAGS
--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
--disable-consent-audit-log Disable log consents
--disable-consent-audit-log Disable consent audit log
--disable-verification Disable verification
--response-webhook-url=<value> Affinidi Iota Framework response webhook URL
--token-max-age=<value> Token expiration time in seconds
Expand All @@ -50,12 +50,12 @@ EXAMPLES
$ affinidi iota create-config --name <value> --wallet-ari <value>
$ affinidi iota create-config --name <value> --wallet-ari <value> --token-max-age <value> --mode websocket
$ affinidi iota create-config --name <value> --wallet-ari <value> --enable-consent-audit-log --enable-verification --token-max-age <value> --mode websocket
$ affinidi iota create-config --name <value> --wallet-ari <value> --token-max-age <value> --mode redirect --redirectUris <value>
$ affinidi iota create-config --name <value> --wallet-ari <value> --enable-consent-audit-log --enable-verification --token-max-age <value> --mode redirect --redirectUris <value>
```

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

## `affinidi iota create-query`

Expand Down Expand Up @@ -83,7 +83,7 @@ EXAMPLES
$ 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.10.2/src/commands/iota/create-query.ts)_
_See code: [src/commands/iota/create-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/iota/create-query.ts)_

## `affinidi iota delete-config`

Expand All @@ -107,7 +107,7 @@ EXAMPLES
$ affinidi iota delete-config --id <value>
```

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

## `affinidi iota delete-query`

Expand All @@ -133,7 +133,7 @@ EXAMPLES
$ 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.10.2/src/commands/iota/delete-query.ts)_
_See code: [src/commands/iota/delete-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/iota/delete-query.ts)_

## `affinidi iota get-config`

Expand All @@ -157,7 +157,7 @@ EXAMPLES
$ affinidi iota get-config --id <value>
```

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

## `affinidi iota get-query`

Expand All @@ -183,7 +183,7 @@ EXAMPLES
$ 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.10.2/src/commands/iota/get-query.ts)_
_See code: [src/commands/iota/get-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/iota/get-query.ts)_

## `affinidi iota list-configs`

Expand All @@ -202,7 +202,7 @@ EXAMPLES
$ affinidi iota list-configs
```

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

## `affinidi iota list-queries`

Expand All @@ -226,7 +226,7 @@ EXAMPLES
$ affinidi iota list-queries --configuration-id <value>
```

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

## `affinidi iota update-config`

Expand Down Expand Up @@ -266,7 +266,7 @@ EXAMPLES
$ affinidi iota update-config --id <value>
```

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

## `affinidi iota update-query`

Expand Down Expand Up @@ -296,4 +296,4 @@ EXAMPLES
$ 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.10.2/src/commands/iota/update-query.ts)_
_See code: [src/commands/iota/update-query.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/iota/update-query.ts)_
22 changes: 13 additions & 9 deletions docs/issuance.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,18 @@ Creates credential issuance configuration in your active project
```
USAGE
$ affinidi issuance create-config [--json] [--no-color] [--no-input] [-n <value>] [-d
<value>] [-w <value>] [--credential-offer-duration <value>] [-f <value>]
<value>] [-w <value>] [--credential-offer-duration <value>] [-f <value>] [--enable-webhook] [-u <value>]
FLAGS
-d, --description=<value> Description of the credential issuance configuration
-f, --file=<value> Location of a json file containing the list of allowed schemas for creating a
credential offer. One or more schemas can be added to the issuance. The
credential type ID must be unique
-n, --name=<value> Name of the credential issuance configuration
-u, --webhook-url=<value> URL to receive notifications after VC is claimed
-w, --wallet-id=<value> ID of the wallet
--credential-offer-duration=<value> Credential offer duration in seconds
--[no-]enable-webhook Enable/Disable VC claim notifications
GLOBAL FLAGS
--json Format output as json.
Expand All @@ -35,10 +37,10 @@ GLOBAL FLAGS
EXAMPLES
$ affinidi issuance create-config -n <value> -w <value> -f credentialSchemas.json
$ affinidi issuance create-config --name <value> --wallet-id <value> --description <value> --credential-offer-duration <value> --file credentialSchemas.json
$ affinidi issuance create-config --name <value> --wallet-id <value> --description <value> --credential-offer-duration <value> --file credentialSchemas.json --[no-]enable-webhook --webhook-url <value>
```

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

## `affinidi issuance delete-config`

Expand All @@ -62,7 +64,7 @@ EXAMPLES
$ affinidi issuance delete-config --id <value>
```

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

## `affinidi issuance get-config`

Expand All @@ -86,7 +88,7 @@ EXAMPLES
$ affinidi issuance get-config --id <value>
```

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

## `affinidi issuance list-configs`

Expand All @@ -105,7 +107,7 @@ EXAMPLES
$ affinidi issuance list-configs
```

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

## `affinidi issuance update-config`

Expand All @@ -114,7 +116,7 @@ Updates credential issuance configuration in your active project
```
USAGE
$ affinidi issuance update-config [--json] [--no-color] [--no-input] [-i <value>] [-n
<value>] [-d <value>] [-w <value>] [--credential-offer-duration <value>] [-f <value>]
<value>] [-d <value>] [-w <value>] [--credential-offer-duration <value>] [-f <value>] [--enable-webhook -u <value>]
FLAGS
-d, --description=<value> Description of the credential issuance configuration
Expand All @@ -123,8 +125,10 @@ FLAGS
credential type ID must be unique
-i, --id=<value> ID of the credential issuance configuration
-n, --name=<value> Name of the credential issuance configuration
-u, --webhook-url=<value> URL to receive notifications after VC is claimed
-w, --wallet-id=<value> ID of the wallet
--credential-offer-duration=<value> Credential offer duration in seconds
--[no-]enable-webhook Enable/Disable VC claim notifications
GLOBAL FLAGS
--json Format output as json.
Expand All @@ -134,7 +138,7 @@ GLOBAL FLAGS
EXAMPLES
$ affinidi issuance update-config -i <value> -f credentialSchemas.json
$ affinidi issuance update-config --id <value> --name <value> --wallet-id <value> --description <value> --credential-offer-duration <value> --file credentialSchemas.json
$ affinidi issuance update-config --id <value> --name <value> --wallet-id <value> --description <value> --credential-offer-duration <value> --file credentialSchemas.json --[no-]enable-webhook --webhook-url <value>
```

_See code: [src/commands/issuance/update-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/issuance/update-config.ts)_
_See code: [src/commands/issuance/update-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/issuance/update-config.ts)_
32 changes: 16 additions & 16 deletions docs/login.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ EXAMPLES
$ affinidi login add-user-to-group --group-name my_group --user-id did:key:12345
```

_See code: [src/commands/login/add-user-to-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/add-user-to-group.ts)_
_See code: [src/commands/login/add-user-to-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/add-user-to-group.ts)_

## `affinidi login create-config`

Expand Down Expand Up @@ -93,7 +93,7 @@ FLAG DESCRIPTIONS
none: For public clients (native/mobile apps) which can not have a secret
```

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

## `affinidi login create-group`

Expand All @@ -117,7 +117,7 @@ EXAMPLES
$ affinidi login create-group --name my_new_group
```

_See code: [src/commands/login/create-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/create-group.ts)_
_See code: [src/commands/login/create-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/create-group.ts)_

## `affinidi login delete-config`

Expand All @@ -141,7 +141,7 @@ EXAMPLES
$ affinidi login delete-config --id <value>
```

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

## `affinidi login delete-group`

Expand All @@ -165,7 +165,7 @@ EXAMPLES
$ affinidi login delete-group --name my_group
```

_See code: [src/commands/login/delete-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/delete-group.ts)_
_See code: [src/commands/login/delete-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/delete-group.ts)_

## `affinidi login export-configs`

Expand All @@ -191,7 +191,7 @@ EXAMPLES
$ affinidi login export-configs --ids "configurationId1 configurationId2" --path "../my-configs.json"
```

_See code: [src/commands/login/export-configs.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/export-configs.ts)_
_See code: [src/commands/login/export-configs.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/export-configs.ts)_

## `affinidi login export-groups`

Expand All @@ -217,7 +217,7 @@ EXAMPLES
$ affinidi login export-groups --names "groupName1 groupName2" --path "../my-user-groups.json"
```

_See code: [src/commands/login/export-groups.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/export-groups.ts)_
_See code: [src/commands/login/export-groups.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/export-groups.ts)_

## `affinidi login get-config`

Expand All @@ -241,7 +241,7 @@ EXAMPLES
$ affinidi login get-config --id <value>
```

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

## `affinidi login get-group`

Expand All @@ -265,7 +265,7 @@ EXAMPLES
$ affinidi login get-group --name my_group
```

_See code: [src/commands/login/get-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/get-group.ts)_
_See code: [src/commands/login/get-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/get-group.ts)_

## `affinidi login import-configs`

Expand All @@ -289,7 +289,7 @@ EXAMPLES
$ affinidi login import-configs --path "../my-configs.json"
```

_See code: [src/commands/login/import-configs.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/import-configs.ts)_
_See code: [src/commands/login/import-configs.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/import-configs.ts)_

## `affinidi login import-groups`

Expand All @@ -313,7 +313,7 @@ EXAMPLES
$ affinidi login import-groups --path "../my-groups.json"
```

_See code: [src/commands/login/import-groups.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/import-groups.ts)_
_See code: [src/commands/login/import-groups.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/import-groups.ts)_

## `affinidi login list-configs`

Expand All @@ -332,7 +332,7 @@ EXAMPLES
$ affinidi login list-configs
```

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

## `affinidi login list-groups`

Expand All @@ -351,7 +351,7 @@ EXAMPLES
$ affinidi login list-groups
```

_See code: [src/commands/login/list-groups.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/list-groups.ts)_
_See code: [src/commands/login/list-groups.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/list-groups.ts)_

## `affinidi login list-users-in-group`

Expand All @@ -376,7 +376,7 @@ EXAMPLES
$ affinidi login list-users-in-group --group-name my_group
```

_See code: [src/commands/login/list-users-in-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/list-users-in-group.ts)_
_See code: [src/commands/login/list-users-in-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/list-users-in-group.ts)_

## `affinidi login remove-user-from-group`

Expand All @@ -400,7 +400,7 @@ EXAMPLES
$ affinidi login remove-user-from-group --group-name my_group --user-id did:key:12345
```

_See code: [src/commands/login/remove-user-from-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/remove-user-from-group.ts)_
_See code: [src/commands/login/remove-user-from-group.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/remove-user-from-group.ts)_

## `affinidi login update-config`

Expand Down Expand Up @@ -448,4 +448,4 @@ FLAG DESCRIPTIONS
none: For public clients (native/mobile apps) which can not have a secret
```

_See code: [src/commands/login/update-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.10.2/src/commands/login/update-config.ts)_
_See code: [src/commands/login/update-config.ts](https://github.com/affinidi/affinidi-cli/blob/v2.13.0/src/commands/login/update-config.ts)_
Loading

0 comments on commit 264970a

Please sign in to comment.