Share CLI command - node
Manage Uni nodes.
Commands
Manage nodes in a Uni
Usage
share node <subcommand>
Sub command | description |
---|---|
node add-api-key | Add an API Key |
node add-jwt-auth | Add a custom JWT Authentication Provider to a Node |
node get | Get node configuration |
node grant-access | Grant user access to a Node |
node remove-jwt-auth | Remove a custom JWT Authentication Provider from a Node |
node revoke-access | Revoke a user's access to a Node |
node schema | Fetch a Node's GraphQL Schema |
node update | Update node configuration |
Examples
# Get Node info
share node get --uni <uniName>
share node get --uni <uniName> --node <nodeName>
share node get --uni <uniName> --node <nodeName> --json | jq '.'
# Update node settings
share node update --uni <uniName> --node <nodeName> --config '{"blockReportEmails":["email@email.com"]}'
# Get node GraphQL schema
share node schema --uni <uniName>
share node schema --uni <uniName> --node <nodeName>
# Grant one or more users access to a Node
share node grant-access --uni <uniName> --node <nodeName> --user john@acme.com --user jill@acme.com --accessLevel ALL
# Revoke one or more users' access to a Node
share node revoke-access --uni <uniName> --node <nodeName> --user john@acme.com --user jill@acme.com
# Add an API Key for a Node
share node add-api-key --uni <uniName> --node <nodeName> --name <name> --expiry <expiry>
# Add a JWT Authentication Provider
share node add-jwt-auth --uni <uniName> --node <nodeName> --name <name> --jwksUrl <jwksUrl> --issuer <issuer> --audience <audience> --scopes <scopes>
# Remove a JWT Authentication Provider
share node remove-jwt-auth --uni <uniName> --node <nodeName> --name <name>
node add-api-key
Add an API Key
Usage
share node add-api-key
Flags
uni
(option) - The name of Uninode
(option) - The name of Node to modifyname
(option) - The name of the API Keyexpiry
(option) - The expiration date of the API Key
Examples
share node add-api-key --uni <uniName> --node <nodeName> --name <name> --expiry <expiry>
node add-jwt-auth
Add a custom JWT Authentication Provider to a Node
Usage
share node add-jwt-auth
Flags
uni
(option) - The name of Uninode
(option) - The name of Node to modifyname
(option) - A unique resource name for this JWT (JSON Web Token) authentication.jwksUrl
(option) - The JSON Web Key Set (JWKS) is a set of keys containing the public keys used to verify any JSON Web Token (JWT) issued by the authorization server and signed using the RS256 signing algorithm.issuer
(option) - The 'iss' (issuer) claim identifies the principal that issued the JWT.audience
(option) - The 'aud' (audience) claim identifies the recipients that the JWT is intended for.scopes
(option) - The scopes required to access the API resource. Separated by spaces (eg. "read:product write:product").
Examples
share node add-jwt-auth --uni <uniName> --node <nodeName> --name <name> --jwksUrl <jwksUrl> --issuer <issuer> --audience <audience> --scopes <scopes>
node get
Get node configuration
Usage
share node get
Flags
uni
(option) - Name of Uninode
(option) - Name of Nodejson
(boolean) - Output return values as JSONrole
(option) - Role name to use for the operation
Examples
share node get --uni <uniName>
share node get --uni <uniName> --node <nodeName>
share node get --uni <uniName> --node <nodeName> --json | jq '.'
node grant-access
Grant user access to a Node
Usage
share node grant-access
Flags
uni
(option) - The name of Uninode
(option) - The name of Node to modifyuser
(option) - E-mail address of the user to which to grant accessaccessLevel
(option) - Access level to grant user(s)
Examples
share node grant-access --uni <uniName> --node <nodeName> --user john@acme.com --user jill@acme.com --accessLevel ALL
node remove-jwt-auth
Remove a custom JWT Authentication Provider from a Node
Usage
share node remove-jwt-auth
Flags
uni
(option) - The name of Uninode
(option) - The name of Node to modifyname
(option) - A unique resource name for this JWT (JSON Web Token) authentication.
Examples
share node remove-jwt-auth --uni <uniName> --node <nodeName> --name <name>
node revoke-access
Revoke a user's access to a Node
Usage
share node revoke-access
Flags
uni
(option) - The name of Uninode
(option) - The name of Node to modifyuser
(option) - E-mail address of the user to which to revoke access
Examples
share node revoke-access --uni <uniName> --node <nodeName> --user john@acme.com --user jill@acme.com
node schema
Fetch a Node's GraphQL Schema
Usage
share node schema
Flags
uni
(option) - Name of Uninode
(option) - Name of Nodejson
(boolean) - Output return values as JSON
Examples
share node schema --uni <uniName>
share node schema --uni <uniName> --node <nodeName>
node update
Update node configuration
Usage
share node update
Flags
uni
(option) - Name of Uninode
(option) - Name of Nodeconfig
(option) - config values to setforce
(boolean) - Force config update & ignore promptsjson
(boolean) - Output return values as JSON
Examples
share node update --uni <uniName> --node <nodeName> --config '{"blockReportEmails":["email@email.com"]}'