List Members

List Members

List this organization's members.

Returns a paginated list of StackHawk Users.

User

A StackHawk User as identified by the platform.

ParameterDefaultDescription
stackhawkId""An internal identifier for this user. This is not the user uuid.
provider{}Information about the login provider assigned to this user. Read More
external{}Information about the user itself, and how they appear in the platform. Read More
createdTimestamp0Creation timestamp of this user.

UserOrganization

Represents the relationship between a User and an Organization they belong to.

ParameterDefaultDescription
organization{}The StackHawk organization this user belongs to.
role"UNKNOWN"The organization role the user belongs to within this organization.
features[]Specific access features available to this organization.
metadata[]The user's organizational specific metadata.
achievements[]Specific product journey events that have triggered for this user.
permissions[]Permissions the User has in this organization.
ParameterDescription
UNKNOWNnull
OWNERnull
ADMINnull
MEMBERnull
TEAM_ADMINnull
VIEW_ONLYnull
SCAN_ONLY_SERVICE_ACCOUNTnull

Organization

A StackHawk Organization.

ParameterDefaultDescription
id""The UUID identifier of this StackHawk Organization.
name""The name of this Organization.
subscription{}The billing subscription of this Organization.
isLinkedToExternalBillingfalseIf this organization is yet connected to external billing (Stripe).
plan""The feature plan this organization belongs to.
features[]Specific overrides to the feature flags in the plan.
settings{}Organization settings.
createdTimestamp0Creation timestamp of this organization.

A StackHawk platform user can belong to many organizations.

Requires read:member permission.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required
^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

UUID identifier for this StackHawk Organization.

Query Params
int32
1 to 1000
Defaults to 10

Pagination response size limit.

int32
≥ 0
Defaults to 0

Pagination request page increment.

string
enum

Resource field to sort paginated response by.

Allowed:
string
enum

Paginated results are sorted 'asc' or 'desc'.

Allowed:
string

Filter users by name or email (case-insensitive search).

roles
array of strings

Filter users by organization roles (comma-separated list of OWNER, ADMIN, MEMBER).

roles
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

401

Unauthorized

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/x-protobuf