Skip to main content
POST
/
users
Create User
curl --request POST \
  --url https://use.hoop.dev/api/users \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "groups": [
    "sre",
    "dba"
  ],
  "name": "John Wick",
  "password": "mysecurepassword",
  "picture": "",
  "slack_id": "U053ELZHB53",
  "status": "active"
}
'
{
  "email": "[email protected]",
  "groups": [
    "sre",
    "dba"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "John Wick",
  "password": "mysecurepassword",
  "picture": "",
  "role": "standard",
  "slack_id": "U053ELZHB53",
  "status": "active",
  "verified": true
}

Body

application/json

The request body resource

​
email
string<email>
required

Email address of the user

​
groups
string[]

Groups registered for this user

Example:
["sre", "dba"]
​
name
string

Display name

Example:

"John Wick"

​
password
string

Local auth cases have a password

Example:

"mysecurepassword"

​
picture
string

The profile picture url to display

Example:

""

​
slack_id
string

The identifier of slack to send messages to users

Example:

"U053ELZHB53"

​
status
enum<string>
default:active

The status of the user. Inactive users cannot access the system

Available options:
active,
inactive,
invited

Response

Created

​
email
string<email>
required

Email address of the user

​
groups
string[]

Groups registered for this user

Example:
["sre", "dba"]
​
id
string<uuid>

Unique identifier of the resource

​
name
string

Display name

Example:

"John Wick"

​
password
string

Local auth cases have a password

Example:

"mysecurepassword"

​
picture
string

The profile picture url to display

Example:

""

​
role
enum<string>

Permission related to the user

  • admin - Has super privileges and has access to any resource in the system
  • standard - Grant access to standard routes.
  • unregistered - Grant access to unregistered routes. It's a transient state where the user is authenticated but is not registered. This state is only available for multi tenant environments
Available options:
admin,
standard,
unregistered
Example:

"standard"

​
slack_id
string

The identifier of slack to send messages to users

Example:

"U053ELZHB53"

​
status
enum<string>
default:active

The status of the user. Inactive users cannot access the system

Available options:
active,
inactive,
invited
​
verified
boolean

DEPRECATED in flavor of role