Share CLI command - node
share node
Manage Uni nodes.
Table of Contents
Commands
Manage nodes in a Uni
Usage for share node
share node <subcommand>| Subcommand | 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 sharing-policy | Manage sharing policies for a node |
node update | Update node configuration |
Examples for share node
❯ Get Node infoshare node get --uni <uniName>share node get --uni <uniName> --node <nodeName>share node get --uni <uniName> --node <nodeName> --json | jq '.'
❯ Update node settingsshare node update --uni <uniName> --node <nodeName> --config '{"blockReportEmails":["email@email.com"]}'
❯ Get node GraphQL schemashare node schema --uni <uniName>share node schema --uni <uniName> --node <nodeName>
❯ Grant one or more users access to a Nodeshare 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 Nodeshare node revoke-access --uni <uniName> --node <nodeName> --user john@acme.com --user jill@acme.com
❯ Add an API Key for a Nodeshare node add-api-key --uni <uniName> --node <nodeName> --name <name> --expiry <expiry>
❯ Add a JWT Authentication Providershare node add-jwt-auth --uni <uniName> --node <nodeName> --name <name> --jwksUrl <jwksUrl> --issuer <issuer> --audience <audience> --scopes <scopes>
❯ Remove a JWT Authentication Providershare node remove-jwt-auth --uni <uniName> --node <nodeName> --name <name>node add-api-key
Add an API Key.
Usage for node add-api-key
share node add-api-keyFlags for node add-api-key
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 for node add-api-key
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-authFlags for node add-jwt-auth
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 for node add-jwt-auth
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 for node get
share node getFlags for node get
uni(option) - Name of Uninode(option) - Name of Nodejson(boolean) - Output return values as JSONrole(option) - Role name to use for the operation
Examples for node get
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 for node grant-access
share node grant-accessFlags for node grant-access
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 for node grant-access
share node grant-access --uni <uniName> --node <nodeName> --user john@acme.com --user jill@acme.com --accessLevel ALLnode remove-jwt-auth
Remove a custom JWT Authentication Provider from a Node.
Usage for node remove-jwt-auth
share node remove-jwt-authFlags for node remove-jwt-auth
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 for node remove-jwt-auth
share node remove-jwt-auth --uni <uniName> --node <nodeName> --name <name>node revoke-access
Revoke a user’s access to a Node.
Usage for node revoke-access
share node revoke-accessFlags for node revoke-access
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 for node revoke-access
share node revoke-access --uni <uniName> --node <nodeName> --user john@acme.com --user jill@acme.comnode schema
Fetch a Node’s GraphQL Schema.
Usage for node schema
share node schemaFlags for node schema
uni(option) - Name of Uninode(option) - Name of Nodejson(boolean) - Output return values as JSON
Examples for node schema
share node schema --uni <uniName>share node schema --uni <uniName> --node <nodeName>node sharing-policy
Manage sharing policies for a node.
See fine grained data permissions documentation for additional information.
Usage for node sharing-policy
share auth sharing-policy <SubCommand>Examples for node sharing-policy
❯ Add a sharing policyshare node sharing-policy add --uni <uniName> --node <nodeName> --name test-policy --entity Product --acl '[]' --description 'test policy for sharing products'node update
Update node configuration.
Usage for node update
share node updateFlags for node update
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 for node update
share node update --uni <uniName> --node <nodeName> --config '{"blockReportEmails":["email@email.com"]}'