Users and Tokens

/user/list

List all users and associated metadata.

• rights: admin
• verbs: GET
• parameters: none

curl

curl https://test-m1.minusonedb.com/user/list \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 user/list

▶200 OKList of users

[
  {
    "username": "user",
    "rights": [
      "schema",
      "get",
      "publish"
    ]
  },
  {
    "username": "admin",
    "rights": [
      "schema",
      "sessionQuery",
      "get",
      "publish",
      "admin",
      "sessionUpdate"
    ]
  }
]

/user/get

Retrieve metadata for specified user.

• rights: admin
• verbs: GET

Parameter	Type	Required
username	String	Yes

curl

curl https://test-m1.minusonedb.com/user/get?username=user \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 user/get -username user

▶200 OKUser metadata

[
  {
    "username": "user",
    "rights": [
      "schema",
      "get",
      "publish"
    ]
  }
]

/user/add

Add new user and specify rights.

• rights: admin
• verbs: POST

Parameter	Type	Required
username	String	Yes. Must be unique.
password	String	Yes
rights	Array	Yes. List of rights to grant to user.

curl

curl https://test-m1.minusonedb.com/user/add \
-d 'username=newUser&password=passphrase&rights=schema,get' \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 user/add -username newUser \
-password passphrase -rights '["schema","get"]'

No response when successful.

/user/update

Update user metadata.

• rights: admin
• verbs: POST

Parameter	Type	Required
username	String	Yes
rights	Array	Yes. List of rights to grant to user.

curl

curl https://test-m1.minusonedb.com/user/update \
-d 'username=user&rights=get,publish' \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 user/update -username user -rights '["get", "publish"]'

No response when successful.

/user/remove

Remove user; the user will no longer be able to access the associated environment.

• rights: admin
• verbs: POST

Parameter	Type	Required
username	String	Yes

curl

curl https://test-m1.minusonedb.com/user/remove \
-d "username=user" \
-H "m1-auth-token: $myToken"

m1 client

m1 test-m1 user/remove -username user

No response when successful.