auth: etcd authentication - auth control

authR Documentation

etcd authentication - auth control

Description

etcd authentication - auth control

Arguments

auth_user, auth_pwd

(character) Username and password for the authenticated user, the root user

...

Further args passed on to GET, PUT, or DELETE

Value

see return for each method

Methods

  • auth_status: get authentication status, returns single boolean, TRUE indicates authentication enabled, and FALSE authentication disabled

  • auth_enable: enable authentication, returns single boolean, TRUE indicates authentication enable request worked

  • auth_disable: disable authentication, returns single boolean, TRUE indicates authentication disable request worked

Examples

## Not run: 
# make a client
cli <- etcd()

# check authentication status
cli$auth_status()

# enable authentication
cli$auth_enable("root", "pickbetterpwd")

# woops, if you got error about root user, craeate one first
cli$user_add(user = "root", password = "pickbetterpwd")

# disable authentication
cli$auth_disable("root", "pickbetterpwd")

# check again, now disabled
cli$auth_status()

# Users
# Add user
cli$user_add("jane", "janepwd", "root", "pickbetterpwd")
# List users
cli$user_list()
# Get a single user
cli$user_get("root")
cli$user_get("jane")
# Delete user
cli$user_delete("jane", "root", "pickbetterpwd")

## End(Not run)

ropensci/etseed documentation built on May 18, 2022, 9:54 a.m.