Skip to content

GetTeam

GET/api/v1/teams/{team}

Fetch a team by name.

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

Set OBLIQUE_API_KEY to your API key.

  • namestringrequired

    Name of the team to request. Format: teams/{team}

200Team

A team represents a group of users. Teams can be hierarchical by specifying a single parent, but can’t be arbitrarily nested.

  • namestring

    Assigned by Oblique. Name of the team of the format teams/{team}.

  • 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 API object 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 API object. Populated by the Oblique Terraform provider.

    • repoDirstring

      Optionally, the subdirectory within repo_uri that holds the Terraform configuration for this API object. 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 team.

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