Thanks to visit codestin.com
Credit goes to developer.hyperproof.app

Skip to content
Hyperproof API
/
/
Users API

Users API (1.0)

Provides access to Hyperpoof user information.

Download OpenAPI description
users.openapi.json
users.openapi.yaml
Languages
Servers
Mock server
https://developer.hyperproof.app/_mock/hyperproof-api/users/users.openapi
Hyperproof US
https://api.hyperproof.app/v1/users
Hyperproof Gov
https://api.hyperproofgov.app/v1/users
Hyperproof EU
https://api.hyperproof.eu/v1/users

Get User

Request

GET /users/me

Description

Retrieves the stored profile information for the requesting user, including details such as name, email, and organization membership.

Security
oauth2
Query
expandstring

Comma separated list of fields to expand. Supported values: identityProviders, organizations.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/users/users.openapi/me?expand=string' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/json
idstring(uuid)

The unique identifier of the user.

Example: "82d7c228-8bcd-11e9-a94b-ab3de8494987"
emailstring

The email address of the user.

Example: "[email protected]"
givenNamestring

The given name of the user.

Example: "John"
surnamestring

The surname of the user.

Example: "Smith"
languagestring

The language preference of the user.

Example: "en"
localestring

The locale preference of the user.

Example: "US"
timeZonestring

The time zone preference of the user.

Example: "America/Los_Angeles"
identityProvidersArray of strings

The list of identity providers for the user.

Example: ["google.com","okta.com"]
organizationRoleIdstring(uuid)

The organization role identifier for the user.

Example: "b97cf308-2504-4b56-bece-1f523070e2d9"
lastLoginstring(date-time)

The date and time of the user's last login (ISO-8601 format).

Example: "2023-05-12T14:16:27.41766Z"
statestring

The state of the user.

Enum"pending""valid""not_invited""disabled""erased"
Example: "verified"
verifiedOnstring(date-time)

The date the user was verified (ISO-8601 format).

Example: "2023-05-12T14:16:27.41766Z"
termsAcceptedOnstring(date-time)

The date the terms were accepted (ISO-8601 format).

Example: "2023-05-12T14:16:27.41766Z"
Response
application/json
{
  "id": "82d7c228-8bcd-11e9-a94b-ab3de8494987",
  "givenName": "John",
  "surname": "Smith",
  "email": "[email protected]",
  "language": "en",
  "locale": "US",
  "timeZone": "America/Los_Angeles",
  "identityProviders": [
    "google.com",
    "okta.com"
  ],
  "organizationRoleId": "b97cf308-2504-4b56-bece-1f523070e2d9",
  "lastLogin": "2023-05-12T14:16:27.4176600+00:00",
  "state": "verified",
  "verifiedOn": "2023-05-12T14:16:27.4176600+00:00",
  "termsAcceptedOn": "2023-05-12T14:16:27.4176600+00:00"
}

Get Users

Request

GET /

Description

Retrieves a list of all users in an organization, including their names, roles, and status information.

Security
oauth2
Query
expandstring

Comma separated list of fields to expand. Supported values: identityProviders, organizationRoleId.

includeDeactivatedboolean

Whether or not to include deactivated users in the response.

curl -i -X GET \
  'https://developer.hyperproof.app/_mock/hyperproof-api/users/users.openapi/?expand=string&includeDeactivated=true' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'

Responses

Success.

Bodyapplication/jsonArray [
idstring(uuid)

The unique identifier of the organization user.

Example: "82182460-f0cf-11ed-9f4f-0e9de14f3c22"
statusstring

The status of the organization user.

Enum"active""archived""deleted""pending""canceled"
emailstring

The email address of the organization user.

Example: "[email protected]"
givenNamestring

The given name of the organization user.

Example: "John"
surnamestring

The surname of the organization user.

Example: "Smith"
languagestring

The language preference of the organization user.

Example: "en"
localestring

The locale preference of the organization user.

Example: "US"
timeZonestring

The time zone preference of the organization user.

Example: "America/Los_Angeles"
userIdstring(uuid)

The user identifier of the organization user.

Example: "8217610f-f0cf-11ed-9f4f-0e9de14f3c22"
typestring

The type of organization user.

Enum"activeUser""contact""deactivatedUser""serviceAccount""deactivatedServiceAccount""syncServiceAccount""deactivatedSyncServiceAccount"
Example: "activeUser"
externalUserLinksArray of objects(ExternalUserLink)
]
Response
application/json
[
  {
    "id": "82182460-f0cf-11ed-9f4f-0e9de14f3c22",
    "givenName": "John",
    "surname": "Smith",
    "email": "[email protected]",
    "language": "en",
    "locale": "US",
    "timeZone": "America/Los_Angeles",
    "userId": "8217610f-f0cf-11ed-9f4f-0e9de14f3c22",
    "type": "activeUser"
  }
]
® 2026 Hyperproof All Rights Reserved.