OPopal
groups

Get groups

Changed on

Returns a list of groups for your organization.

get/groups

Request

  • Base URL
    https://api.opal.dev/v1
  • Auth
    HTTP bearer

Query parameters

cursorstring

The pagination cursor value.

page_sizeinteger

Number of results to return per page. Default is 200.

group_type_filter'ACTIVE_DIRECTORY_GROUP' | 'AWS_SSO_GROUP' | 'DATABRICKS_ACCOUNT_GROUP' | 'DUO_GROUP' | 'GIT_HUB_TEAM' | 'GIT_LAB_GROUP' | 'GOOGLE_GROUPS_GROUP' | 'GOOGLE_GROUPS_GKE_GROUP' | 'LDAP_GROUP' | 'OKTA_GROUP' | 'OKTA_GROUP_RULE' | 'TAILSCALE_GROUP' | 'OPAL_GROUP' | 'OPAL_ACCESS_RULE' | 'AZURE_AD_SECURITY_GROUP' | 'AZURE_AD_MICROSOFT_365_GROUP' | 'CONNECTOR_GROUP' | 'SNOWFLAKE_ROLE' | 'WORKDAY_USER_SECURITY_GROUP' | 'PAGERDUTY_ON_CALL_SCHEDULE' | 'INCIDENTIO_ON_CALL_SCHEDULE' | 'ROOTLY_ON_CALL_SCHEDULE' | 'DEVIN_GROUP' | 'GIT_HUB_ENTERPRISE_TEAM' | 'GRAFANA_TEAM' | 'CLICKHOUSE_ROLE' | 'SLACK_USER_GROUP' | 'CURSOR_GROUP' | 'TWINGATE_GROUP' | 'TWINGATE_GROUP_SYNCED' | 'ZENDESK_GROUP' | 'ZENDESK_ORGANIZATION' | 'HUBSPOT_TEAM' | 'TABLEAU_GROUP' | 'CONFLUENCE_GROUP' | 'JIRA_GROUP' | 'DOCUSIGN_GROUP' | 'ZOOM_GROUP' | 'LINEAR_TEAM' | 'RAMP_DEPARTMENT' | 'RAMP_LOCATION' | 'WRIKE_GROUP' | 'AXIOM_GROUP' | 'ACTIVECAMPAIGN_GROUP' | 'ASANA_TEAM' | 'BITWARDEN_GROUP' | 'BOX_GROUP' | 'CALENDLY_GROUP' | 'ONELOGIN_ROLE' | 'ONELOGIN_GROUP' | 'SQUARE_LOCATION' | 'SQUARE_JOB' | 'RIPPLING_TEAM' | 'RIPPLING_SUPERGROUP'

The type of the group.

Example:OPAL_GROUP

The group type to filter by.

group_idsstring[]

The group ids to filter by.

[
  "1b978423-db0a-4037-a4cf-f79c60cb67b3"
]
group_namestring

Group name.

tag_idsstring[]

The IDs of the tags to filter by. Returns only groups that have any of these tags applied.

requestableboolean

If true, only return groups that allow access requests. Does not check whether the caller is permitted to request the group.

Response

One page worth groups associated with your organization.

nextstring nullable

The cursor with which to continue pagination if additional result pages exist.

previousstring nullable

The cursor used to obtain the current result page.

Example response

{
  "next": "cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
  "previous": "cj1sZXdwd2VycWVtY29zZnNkc2NzUWxNMEUxTXk0ME16UXpNallsTWtJ",
  "results": [
    {
      "group_id": "f454d283-ca87-4a8a-bdbb-df212eca5353",
      "app_id": "b5a5ca27-0ea3-4d86-9199-2126d57d1fbd",
      "name": "Payments Production Admin",
      "description": "This group represents Active Directory group \"Payments Production Admin\". We use this AD group to facilitate staging deployments and qualifying new releases.",
      "admin_owner_id": "7c86c85d-0651-43e2-a748-d69d658418e8",
      "group_leader_user_ids": [
        "7c86c85d-0651-43e2-a748-d69d658418e8"
      ],
      "remote_id": "037m2jsg218b2wb",
      "remote_name": "Finance Team",
      "group_type": "ACTIVE_DIRECTORY_GROUP",
      "max_duration": 120,
      "recommended_duration": 60,
      "extensions_duration_in_minutes": 60,
      "require_manager_approval": false,
      "require_support_ticket": false,
      "require_mfa_to_approve": false,
      "require_mfa_to_request": false,
      "auto_approval": false,
      "is_requestable": true
    },
    {
      "group_id": "99d0b81d-14be-4cf6-bd27-348b4af1d11b",
      "app_id": "a7c3e291-1234-4abc-9def-1234567890ab",
      "name": "Integrations On-Call",
      "description": "Manages the Integrations Team on-call privileged resources. This group is automatically synced with the on-call rotation defined in PagerDuty.",
      "admin_owner_id": "4220bc12-ab8a-4b5d-be7b-f6bbcf9159f3",
      "group_leader_user_ids": [],
      "remote_id": "pagerduty-schedule:P123XYZ",
      "remote_name": "Integrations On-Call",
      "group_type": "PAGERDUTY_ON_CALL_SCHEDULE",
      "max_duration": 360,
      "recommended_duration": 120,
      "extensions_duration_in_minutes": 0,
      "require_manager_approval": false,
      "require_support_ticket": true,
      "require_mfa_to_approve": false,
      "require_mfa_to_request": false,
      "auto_approval": false,
      "is_requestable": true
    }
  ]
}

Changes

  • e7877ea96eabRevision changes
    • warning

      added the new ACTIVECAMPAIGN_GROUP enum value to the // response property for the response status

    • info

      added the new enum value ACTIVECAMPAIGN_GROUP to the query request parameter group_type_filter

    • info

      added the optional property /// to the response with the status

  • c54b1c07fcdbRevision changes
    • warning

      added the new ONELOGIN_GROUP enum value to the // response property for the response status

    • warning

      added the new ONELOGIN_ROLE enum value to the // response property for the response status

    • info

      added the new enum value ONELOGIN_GROUP to the query request parameter group_type_filter

    • info

      added the new enum value ONELOGIN_ROLE to the query request parameter group_type_filter

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status