List All Users

This endpoint retrieves a complete list of all users in the organization. It provides essential details for each user, enabling efficient management and monitoring of user accounts.

Request

Method: GET

URL: https://api.ssojet.com/api/v1/users

Query Parameters:

client_id (string, required): The client ID for authentication.

Response

[{ "_id": "string",
    "account_id": "string",
    "connection_id": "string",
    "email": "string",
    "first_name": "string",
    "last_name": "string",
    "groups": "arrary",
    "raw_attributes": "any",
    "roles": "arrary",
    "passkey_credential": "object",
    "phone_id": "string",
    "created_at": "date",
    "modified_at": "date",
    "email_verified": boolean,
    "is_active": boolean,
    "LastLoginAt":"date",
    "tenants": object,
    "identities":  "arrary"
}]

The response will contain the details of the user, including their user ID, name, email, and other relevant information.

Response Status Code

200 OK: Magic link sent successfully.

400 Bad Request: Invalid email format.

500 Internal Server Error: An error occurred while processing the request.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Query Params

client_id

string

required

This identifies the application making the request to the SSOJET server. You can find your client ID on the API Keys page in the dashboard

Example:

string

limit

string

required

This paramert is used in users api for pagination or controlling the number of results returned

Example:

string

Header Params

Content-Type

string

optional

Default:

application/json

User-Agent

string

optional

Default:

SSOjet/1.0.0 (https://ssojet.com)

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

⚪0List All Users

application/json

Body

_id

string

required

account_id

string

required

connection_id

string

required

string

required

first_name

string

required

last_name

string

required

groups

null

required

raw_attributes

null

required

roles

null

required

passkey_credential

null

required

phone_id

string

required

created_at

string

required

modified_at

string

required

email_verified

boolean

required

is_active

boolean

required

LastLoginAt

null

required

tenants

null

required

identities

null

required

Example

{
  "_id": "6694c154565dfee5166d1cc7",
  "account_id": "668e7e5946b448ab754b44a5",
  "connection_id": "668e7e5946b448ab754b44a6",
  "email": "user@example.com",
  "first_name": "Test1",
  "last_name": "Test1",
  "groups": null,
  "raw_attributes": null,
  "roles": null,
  "passkey_credential": null,
  "phone_id": "",
  "created_at": "2024-07-15T06:27:32.003681223Z",
  "modified_at": "2024-07-15T06:27:32.003681223Z",
  "email_verified": false,
  "is_active": true,
  "LastLoginAt": null,
  "tenants": null,
  "identities": null
}

List All Users

List All Users#

Request#

Response#

Request

Request samples

Responses

List All Users

Request

Response