Skip to content

ListIntegrations

GET/api/v1/integrations

List the integrations connected to this organization.

Example request

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

Set OBLIQUE_API_KEY to your API key.

Query parameters

  • pageSizeinteger (int32)
  • pageTokenstring
  • showDeletedboolean

    If true, the response will include deleted integrations.

Response

200ListIntegrationsResponse
  • integrationsIntegration[]
    • namestring

      Assigned by Oblique.

    • managementManagement

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

    • displayNamestring

      A human readable name of the integration. For example “Okta Test”.

    • createTimestring (date-time)read-only

      Create and update timestamps.

    • updateTimestring (date-time)read-only
    • deleteTimestring (date-time)read-only

      The time when the integration was deleted.

    • One of

      • oktaOkta
        • apiTokenstringrequired

          The API token to use when making calls to Okta. Required when the integration is created.

        • domainBaseUristringrequired

          Full base URL of the Okta domain, including the schema. For example: https://dev-45752433-admin.okta.com

        • displayNamestring

          Will be removed in the future in favor of top level display_name.

        • organizationIdstringread-only

          The tenant ID of the Okta organization. This is detected on first creation of the integration and is not editable.

        • ignoreUsersIgnoreUsers
          • attributesUserAttribute[]required

            If provided, the integration will ignore users that have any of the given attributes set to this value. If multiple attributes are provided, the user will be ignored if any of their attributes match these rules. Custom attributes are supported.

            • keystringrequired

              The key of the attribute. For example “department”.

            • valuestringrequired

              The value of the attribute. For example “Engineering”.

    • createGroupForNewTeamsboolean

      If true, the integration will create a group for each new team.

    • userCountinteger (int32)read-only

      The number of users that the system contains.

    • resourceCountinteger (int32)read-only

      The number of resources that the system manages.

    • resourcePushCountinteger (int32)read-only

      The number of resources that have been pushed to the integration.

    • resourcePullCountinteger (int32)read-only

      The number of resources that have been pulled from the integration.

    • supportsPushbooleanread-only

      Whether the integration can push to at least one of the objects it reports. Some of its write capabilities may still be unavailable. Determined by the access the integration was granted, and re-evaluated on every sync.

    • needsReauthbooleanread-only

      Whether the integration is missing access that Oblique asks for, which is granted by reconnecting it. Re-evaluated on every sync.

  • nextPageTokenstring

Errors

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