STstackhawk
Organization Teams

List Available Team Users

Changed on

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.

ParameterDefaultDescription
users[]
nextPageToken""

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

Requires read:team permission.

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

Request

  • Base URL
    https://api.stackhawk.com
  • URL
    https://api.stackhawk.com/api/v1/org/{orgId}/teams/available/users
  • Auth
    HTTP bearer

Path parameters

orgIdstring uuid required

UUID identifier for this StackHawk Organization.

Query parameters

teamIdstring uuid

Exclude the users that already belong to this Team.

Response

OK

nextPageTokenstring

Changes