Link Search Menu Expand Document
Start for Free

stardog-admin catalog credentials-add

Description

Add stored credentials for external metadata sources

Usage

stardog-admin [ --krb5 ] [ --krb5-disable-rdns ] [ --server <server url> ] catalog credentials-add [ --client-id <clientId> ] [ --client-secret <clientSecret> ] [ --creds-password <credsPassword> ] [ --creds-token <authToken> ] [ --creds-username <credsUsername> ] [ {-f | --file} <file> ] [ {-l | --label} <label> ] [ {-p | --passwd} <password> ] [ {-P | --ask-password} ] [ --run-as <username> ] [ --token <token> ] [ {-u | --username} <username> ] [ {-v | --verbose} ]

Options

Name, shorthand Description
--client-id <clientId> Client ID for OAuth/client credential authentication
--client-secret <clientSecret> Client secret for OAuth/client credential authentication
--creds-password <credsPassword> Password for username/password authentication for the credential being added
--creds-token <authToken> Token for token-based authentication (e.g., API token, bearer token) for the credential being added
--creds-username <credsUsername> Username for username/password authentication for the credential being added
-f <file>, --file <file> Path to a JSON file containing the credentials. When provided, no interactive prompts are shown.
--krb5 Use the Kerberos environment.
--krb5-disable-rdns Disable reverse DNS lookup for Kerberos clients.
-l <label>, --label <label> Description/label for the credentials
-p <password>, --passwd <password> Password.
-P, --ask-password Prompt for password.
--run-as <username> User to impersonate when running the command
--server <server url> URL of Stardog Server. If this option isn’t specified, it will be read from JVM argument ‘stardog.default.cli.server’. If the JVM arg isn’t set, the default value ‘http://localhost:5820’ is used. If server URL has no explicit port value, the default port value ‘5820’ is used. Example: ‘stardog-admin –server http://12.34.56.78:5820 server stop’
--token <token> Stardog JWT token
-u <username>, --username <username> User name.
-v, --verbose Flag that can cause more detailed information to be printed such as errors and status. Exact output depends upon the command and options used.

Discussion

Add stored credentials for external metadata sources. Credentials can be provided interactively, via command-line options, or via a JSON file. When a JSON file is provided, no interactive prompts are shown. The JSON file format matches the REST API:

Username/Password: {“username”:”…”,”password”:”…”,”label”:”…”} Client credentials: {“clientId”:”…”,”clientSecret”:”…”,”label”:”…”} Token: {“token”:”…”,”label”:”…”}

External secrets can be included: {“username”:”{user}”,”password”:”{pass}”,”label”:”…”, “secret”:{“manager”:”","id":""}}