PreviewGroup

POST/api/v1/groups:previewGroup

Work out who would be in a group, without creating or changing one. Use this to check a rule before saving it.

Example request

US
Europe

curl -X POST \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string" }' \
  "https://us.oblique.security/api/v1/groups:previewGroup"

Set OBLIQUE_API_KEY to your API key.

curl -X POST \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{ "displayName": "string" }' \
  "https://eu.oblique.security/api/v1/groups:previewGroup"

Set OBLIQUE_API_KEY to your API key.

Request body

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 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.
memberCountinteger (int32)read-only
The number of members in the group.
One of
- attributes
- reporting
- 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
  The integration that supplies the attribute to match on.
  
  Format: integrations/{integration}
  keystringrequired
  valuestringrequired
  operatorstring
  Allowed values: EQUAL, NOT_EQUAL
  Comparison operator for the attribute. Defaults to EQUAL when unset.
- reportingReporting
  Reporting matches members of a group based on their reporting line.
  managerstringrequired
  The manager whose reports make up the group.
  
  Format: users/{user}
  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.

Response

200PreviewGroupResponse

previewGroupPreview
The preview of the group.
- usersstring[]
  A list of users who are members of the group.

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