Skip to content

ListTeamMembers

GET/api/v1/teams/{team}/members

List all members on a team.

Example request

curl \
-H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
"https://us.oblique.security/api/v1/teams/{team}/members"

Set OBLIQUE_API_KEY to your API key.

Path parameters

  • parentstringrequired

    Name of the team to list the members of. Can provide the name teams/- to list across all teams.

    Format: teams/{team}

Query parameters

  • pageSizeinteger (int32)

    The maximum number of teams to return. This service may return fewer than this value.

  • pageTokenstring

    A page token, received from a previous ListTeamMembers call.

  • filterstring

    Filter that can be used to search for memberships by values other than the team. This currently only supports searching by the member.

    filter=member="users/{user}" or filter=member="users/me"

  • showDeletedboolean

    If true, include memberships that reference deleted users or teams in the response.

Response

200ListTeamMembersResponse
  • teamMembersTeamMember[]

    The teams managed by this server.

    • namestring

      Assigned by Oblique. The name of the membership. Memberships are always child resources of a given team. The {member} component is an arbitrary identifier, and doesn’t correspond to the actual member.

      Format: teams/{team}/members/{member}

    • managementManagement

      How this membership is managed. Inherited from the parent team: memberships of Terraform-managed teams are themselves Terraform managed and can only be created, updated, or deleted through the Terraform provider; manage the parent team to change this. Omitted from responses when the parent team is manually managed (the default).

      • managerstring
        Allowed values: TERRAFORM

        How the resource is managed. Set automatically by the server based on the caller: Terraform clients produce TERRAFORM; for all other clients the management field is left unset on the response.

      • repoUristring

        URI of the VCS repository that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.

      • repoDirstring

        Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this resource. Populated by the Oblique Terraform provider.

    • createTimestring (date-time)read-only

      Create and update timestamps.

    • updateTimestring (date-time)read-only
    • memberstringrequired

      The name of the member. This currently only supports users, but will be expanded to support teams as well. Immutable after creation.

      Format: users/{user}

    • justificationstring

      Why the user is part of the team.

    • requeststringread-only

      If present, the request that most recently created or updated this membership.

      Format: requests/{request}

  • nextPageTokenstring

    A token, which can be sent as page_token to retrieve the next page.

Errors

StatusMeaning
400Malformed request
401Missing or invalid API key
403Not allowed for this API key
404Not found
429Too many requests
500Internal server error