GetGroup

GET/api/v1/groups/{group}

Fetch a group by name.

Example request

US

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

Set OBLIQUE_API_KEY to your API key.

Europe

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

Set OBLIQUE_API_KEY to your API key.

Path parameters

• namestringrequired

Response

200Group

A group is a collection of users that share a set of attributes such as role, location, reporting chain, etc. These are intended to be used with ABAC (attribute based access control) entitlements.

• namestring

  Assigned by Oblique. Name of the group of the form groups/{group}

• createTimestring (date-time)read-only

  The time when this group was created.

• updateTimestring (date-time)read-only

  The time when this object was last updated. This does not correspond to any membership changes of this group.

• deleteTimestring (date-time)read-only

  Groups can only be soft-deleted to preserve logs and history. If this field is present, the group has been deleted and won’t be returned in lists.

• displayNamestringrequired

  Human readable name of the group.

• managementManagement

  How this group is managed. Set automatically by the server based on the calling client. Omitted from responses when the group 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.

• memberCountinteger (int32)read-only

  The number of members in the group.

• One of

  attributes

  • attributesAttributes

    Attributes defines attribute based selection of members of a group, matching users with a given set of attributes.

    • matchAttributeMatch[]required

      A set of and conditions that a user must match. The user’s attributes must match all values provided.

      • userAttributeUserAttributeMatchrequired

        A user attribute key and value that must be matched.

        • integrationstringrequired
        • keystringrequired
        • valuestringrequired
        • operatorstring
          Allowed values: EQUAL, NOT_EQUAL

          Comparison operator for the attribute. Defaults to EQUAL when unset

  reporting

  • reportingReporting

    Reporting matches members of a group based on their reporting line

    • managerstringrequired
    • includeIndirectboolean
    • includeManagerboolean

      Whether the reporting group should include the manager in membership as well. Defaults to false.

    • createManagerOwnerboolean

      If present on create operations (or during update with allow_missing), the manager will automatically be made an owner. Not returned on get or list operations.

• usersstring[]read-only

  List of users that are members of this group. This is only populated for get or update requests, not during lists.

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