loading

activate

Activates a service user given a key or key file, and changes the current session to that of the service user. Subsequent commands are executed under the newly activated service user.

Usage

yext service-users activate [flags]

Flags

Flag Description
-h, --help Help for service-users activate
--key string Key to activate a service user (the value contained in the key file)
--key-file string Path to the key file to activate a service user
-u, --universe string The global environment this configuration is for, either “production” or “sandbox”. By default this value is “production”


create

Creates a service user with the specified name. The created service user details are encrypted and written to the provided key-file-path.

Usage

yext service-users create [NAME] [KEY-FILE-PATH] [flags]

Flags

Flag Description
-h, --help Help for service-users create


list

Lists all the service users under the current session. The currently selected service user is saved to the given path.

Usage

yext service-users list [PATH] [flags]

Flags

Flag Description
-h, --help Help for service-users list
--download-any-user Downloads any existing service user to the specified path. Useful for scripting use cases.


remove

Removes the service user with the provided name.

Usage

yext service-users remove [NAME] [flags]

Flags

Flag Description
-h, --help Help for service-users create