|
| 1 | +--- |
| 2 | +name: cli-admin |
| 3 | +description: CLI tool (csdk) for the admin API — provides CRUD commands for 32 tables and 13 custom operations |
| 4 | +--- |
| 5 | + |
| 6 | +# cli-admin |
| 7 | + |
| 8 | +<!-- @constructive-io/graphql-codegen - DO NOT EDIT --> |
| 9 | + |
| 10 | +CLI tool (csdk) for the admin API — provides CRUD commands for 32 tables and 13 custom operations |
| 11 | + |
| 12 | +## Usage |
| 13 | + |
| 14 | +```bash |
| 15 | +# Context management |
| 16 | +csdk context create <name> --endpoint <url> |
| 17 | +csdk context use <name> |
| 18 | + |
| 19 | +# Authentication |
| 20 | +csdk auth set-token <token> |
| 21 | + |
| 22 | +# Config variables |
| 23 | +csdk config set <key> <value> |
| 24 | +csdk config get <key> |
| 25 | + |
| 26 | +# CRUD for any table (e.g. org-get-managers-record) |
| 27 | +csdk org-get-managers-record list |
| 28 | +csdk org-get-managers-record get --id <value> |
| 29 | +csdk org-get-managers-record create --<field> <value> |
| 30 | + |
| 31 | +# Non-interactive mode (skip all prompts, use flags only) |
| 32 | +csdk --no-tty org-get-managers-record list |
| 33 | +``` |
| 34 | + |
| 35 | +## Examples |
| 36 | + |
| 37 | +### Set up and query |
| 38 | + |
| 39 | +```bash |
| 40 | +csdk context create local --endpoint http://localhost:5000/graphql |
| 41 | +csdk context use local |
| 42 | +csdk auth set-token <token> |
| 43 | +csdk org-get-managers-record list |
| 44 | +``` |
| 45 | + |
| 46 | +### Non-interactive mode (for scripts and CI) |
| 47 | + |
| 48 | +```bash |
| 49 | +csdk --no-tty org-get-managers-record create --<field> <value> |
| 50 | +``` |
| 51 | + |
| 52 | +## References |
| 53 | + |
| 54 | +See the `references/` directory for detailed per-entity API documentation: |
| 55 | + |
| 56 | +- [context](references/context.md) |
| 57 | +- [auth](references/auth.md) |
| 58 | +- [config](references/config.md) |
| 59 | +- [org-get-managers-record](references/org-get-managers-record.md) |
| 60 | +- [org-get-subordinates-record](references/org-get-subordinates-record.md) |
| 61 | +- [app-permission](references/app-permission.md) |
| 62 | +- [org-permission](references/org-permission.md) |
| 63 | +- [app-level-requirement](references/app-level-requirement.md) |
| 64 | +- [org-member](references/org-member.md) |
| 65 | +- [app-permission-default](references/app-permission-default.md) |
| 66 | +- [org-permission-default](references/org-permission-default.md) |
| 67 | +- [app-admin-grant](references/app-admin-grant.md) |
| 68 | +- [app-owner-grant](references/app-owner-grant.md) |
| 69 | +- [org-admin-grant](references/org-admin-grant.md) |
| 70 | +- [org-owner-grant](references/org-owner-grant.md) |
| 71 | +- [app-limit-default](references/app-limit-default.md) |
| 72 | +- [org-limit-default](references/org-limit-default.md) |
| 73 | +- [org-chart-edge-grant](references/org-chart-edge-grant.md) |
| 74 | +- [membership-type](references/membership-type.md) |
| 75 | +- [app-limit](references/app-limit.md) |
| 76 | +- [app-achievement](references/app-achievement.md) |
| 77 | +- [app-step](references/app-step.md) |
| 78 | +- [claimed-invite](references/claimed-invite.md) |
| 79 | +- [app-grant](references/app-grant.md) |
| 80 | +- [app-membership-default](references/app-membership-default.md) |
| 81 | +- [org-limit](references/org-limit.md) |
| 82 | +- [org-claimed-invite](references/org-claimed-invite.md) |
| 83 | +- [org-grant](references/org-grant.md) |
| 84 | +- [org-chart-edge](references/org-chart-edge.md) |
| 85 | +- [org-membership-default](references/org-membership-default.md) |
| 86 | +- [app-membership](references/app-membership.md) |
| 87 | +- [org-membership](references/org-membership.md) |
| 88 | +- [invite](references/invite.md) |
| 89 | +- [app-level](references/app-level.md) |
| 90 | +- [org-invite](references/org-invite.md) |
| 91 | +- [app-permissions-get-padded-mask](references/app-permissions-get-padded-mask.md) |
| 92 | +- [org-permissions-get-padded-mask](references/org-permissions-get-padded-mask.md) |
| 93 | +- [org-is-manager-of](references/org-is-manager-of.md) |
| 94 | +- [app-permissions-get-mask](references/app-permissions-get-mask.md) |
| 95 | +- [org-permissions-get-mask](references/org-permissions-get-mask.md) |
| 96 | +- [steps-achieved](references/steps-achieved.md) |
| 97 | +- [app-permissions-get-mask-by-names](references/app-permissions-get-mask-by-names.md) |
| 98 | +- [org-permissions-get-mask-by-names](references/org-permissions-get-mask-by-names.md) |
| 99 | +- [app-permissions-get-by-mask](references/app-permissions-get-by-mask.md) |
| 100 | +- [org-permissions-get-by-mask](references/org-permissions-get-by-mask.md) |
| 101 | +- [steps-required](references/steps-required.md) |
| 102 | +- [submit-invite-code](references/submit-invite-code.md) |
| 103 | +- [submit-org-invite-code](references/submit-org-invite-code.md) |
0 commit comments