List Available Team Users

GET /api/v1/org/{orgId}/teams/available/users

List Available Team Users

Get the users in this StackHawk organization that are available to be assigned to a Team.

Supply the optional teamId query parameter to exclude the users that already belong to that Team. Omit it to list every user in the organization.

Use this endpoint to discover the user IDs to supply when creating or updating a Team.

Parameter	Default	Description
users	[]
nextPageToken	""

All users that belong to this organization can call this endpoint.

Requires read:team permission.

Path parameters

orgIdstring · uuidrequired

UUID identifier for this StackHawk Organization.

Query parameters

teamIdstring · uuid

Exclude the users that already belong to this Team.

Response

nextPageToken

string

users

organization.TeamUser[]

Hide child attributesShow child attributes

users.email

string

users.role

string

users.userId

string

users.userName

string

nextPageToken

string

users

organization.TeamUser[]

Hide child attributesShow child attributes

users.email

string

users.role

string

users.userId

string

users.userName

string

Unauthorized

GET /api/v1/org/{orgId}/teams/available/users

cURL

curl --request GET \
  --url 'https://api.stackhawk.com/api/v1/org/{orgId}/teams/available/users' \
  --header 'Authorization: Bearer YOUR_ACCESS_TOKEN'

Copy

List Available Team Users