List external users from IDP

GET

/api/v1/external-users

curl --request GET \
  --url https://localhost:8080/api/v1/external-users \
  --header 'Authorization: <Authorization>'

Get a list of users from the configured identity provider (e.g., Keycloak, Auth0), showing which users exist in the IDP but may not yet exist in the platform

Authorizations

• BearerAuth
• ApiKeyAuth

Parameters

Query Parameters

limit

integer

Number of users to return (default: 100, max: 100)

offset

integer

Number of users to skip

email

string

Filter by email address

username

string

Filter by username

Responses

200

List of external users

Media type application/json

object

pagination

object

limit

integer

offset

integer

provider

object

name

string

type

string

total

integer

users

Array<object>

object

active

boolean

createdAt

string

displayName

string

email

string

emailVerified

boolean

existsInPlatform

boolean

firstName

string

groups

Array<string>

id

string

lastLoginAt

string

lastName

string

metadata

object

key

additional properties

pictureUrl

string

platformUserId

string

roles

Array<string>

updatedAt

string

username

string

Example ^generated

{
  "pagination": {
    "limit": 1,
    "offset": 1
  },
  "provider": {
    "name": "example",
    "type": "example"
  },
  "total": 1,
  "users": [
    {
      "active": true,
      "createdAt": "example",
      "displayName": "example",
      "email": "example",
      "emailVerified": true,
      "existsInPlatform": true,
      "firstName": "example",
      "groups": [
        "example"
      ],
      "id": "example",
      "lastLoginAt": "example",
      "lastName": "example",
      "metadata": {
        "additionalProperty": "example"
      },
      "pictureUrl": "example",
      "platformUserId": "example",
      "roles": [
        "example"
      ],
      "updatedAt": "example",
      "username": "example"
    }
  ]
}

400

Bad request - Invalid user listing parameters

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

401

Unauthorized

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

403

Forbidden - requires Organization Owner role

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

500

Internal server error

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}

501

Not Implemented - IDP does not support user listing

Media type application/json

object

error

string

error_description

string

Example

{
  "error": "Unauthorized",
  "error_description": "Invalid token"
}