Skip to main content
GET
/
userinfo
Get UserInfo
curl --request GET \
  --url https://use.hoop.dev/api/userinfo
{
  "email": "jsmith@example.com",
  "feature_ask_ai": "unavailable",
  "groups": [
    "sre",
    "dba"
  ],
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "intercom_hmac_digest": "<string>",
  "is_admin": true,
  "is_multitenant": true,
  "name": "John Wick",
  "org_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "org_license": "",
  "org_name": "JohnWickCorp",
  "password": "mysecurepassword",
  "picture": "",
  "role": "standard",
  "slack_id": "U053ELZHB53",
  "status": "active",
  "tenancy_type": "selfhosted",
  "verified": true,
  "webapp_users_management": "on"
}

Response

OK

​
email
string<email>
required

Email address of the user

​
feature_ask_ai
enum<string>

Ask AI feature uses ChatGPT allowing using natural language to construct input based on the context of connections

  • unavailable - the ChatGPT credentials is not available
  • enabled - ChatGPT credentials is available and an administrator has provide consent to send introspection schema to GTP-4
  • disabled - ChatGPT credentials is available and an administrator has not provided consent to send introspection schema to GTP-4
Available options:
unavailable,
enabled,
disabled
​
groups
string[]

Groups registered for this user

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

Unique identifier of the resource

​
intercom_hmac_digest
string
​
is_admin
boolean

DEPRECATED in flavor of role

​
is_multitenant
boolean

DEPRECATED is flavor of tenancy_type

​
name
string

Display name

Example:

"John Wick"

​
org_id
string<uuid>

Organization unique identifier

​
org_license
string

DEPRECATED in flavor of license route

Example:

""

​
org_name
string
default:JohnWickCorp

Organization name

​
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
​
tenancy_type
enum<string>

The gateway tenancy type

  • selfhosted - Single tenant gateway, organization is registered on gateway startup and signup is performed on login
  • multitenant - Allows multiple organization through a signup process
Available options:
selfhosted,
multitenant
​
verified
boolean

DEPRECATED in flavor of role

​
webapp_users_management
enum<string>
default:on

Enable or disable Webapp users management

  • on - Enable the users management view on Webapp
  • on - Disable the users management view on Webapp
Available options:
on,
off