ListTeams

GET/api/v1/teams

List teams or search for teams by member or owner.

Example request

US
Europe

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

Set OBLIQUE_API_KEY to your API key.

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

Set OBLIQUE_API_KEY to your API key.

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 ListTeams call.
showDeletedboolean
If true, include deleted teams in the response.
filterstring
Filter that can be used to search for teams. Supports filter by owner:
- owner="users/{id}", owner="users/me" - For users this includes transitive ownerships via another team or group.
- owner="teams/{id}"
- owner="groups/{id}"
Or by team member:
- member="users/{id}"
- member="users/me" - also supports the current user’s teams.
Or by display name, with support for * wildcards and the case-insensitive ~= comparator:
```
displayName = "Platform Team"

// Matches "Platform Team" and "Platform Engineering"
displayName = "Platform *"

// Case-insensitive, matches "Platform Team" and "platform eng"
displayName ~= "platform *"

displayName = "Platform *" OR displayName ~= "security *"
```
Display name filters can’t be combined with owner or member filters.

Response

200ListTeamsResponse

teamsTeam[]
The teams managed by this server.
- namestring
  Assigned by Oblique.
- displayNamestringrequired
  Displayed name of the team.
- descriptionstring
  Longer description.
- managementManagement
  How this team is managed. Set automatically by the server based on the calling client. Omitted from responses when the 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
- deleteTimestring (date-time)read-only
  Teams can only be soft-deleted to preserve logs and history.
- memberCountinteger (int32)read-only
  The number of members in the group.
- resourceDescriptionstring
  If Oblique is configured to create a resource for the team, this will be the description of that resource. If not provided, a default description will be used. This is only valid on creation events.
nextPageTokenstring
A token, which can be sent as page_token to retrieve the next page.

Errors

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