Skip to content
Docs

ListIntegrations

GET/api/v1/integrations

List the integrations connected to this organization.

Example request

Section titled “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

Section titled “Query parameters”
  • pageSizeinteger (int32)
  • pageTokenstring
  • showDeletedboolean

    If true, the response will include deleted integrations.

  • filterstring

    Filter that can be used to search for integrations. Supports filtering by owner:

    • owner="users/{id}", owner="users/me" - For users this includes ownership through a team or group.
    • owner="teams/{id}"
    • owner="groups/{id}"

Response

Section titled “Response”
200ListIntegrationsResponse
  • integrationsIntegration[]
    • namestring

      Assigned by Oblique. Name of the integration of the format integrations/{integration}.

    • 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 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.

    • 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.

    • credentialUpdateTimestring (date-time)read-only

      The time a person last connected new credentials for the integration, for example by adding it, reauthorizing it, or reinstalling its app. Automatic token refreshes don’t change it.

    • clientIdstring

      The ID of the OAuth client the integration authenticates with for integrations like Tailscale and 1Password. Required when such an integration is created, rejected for other types. Provide alongside client_secret to rotate client.

    • clientSecretstring

      The secret issued for client_id. Required when an integration that authenticates with OAuth client credentials is created, and never returned by the API. Provide alongside client_id to rotate client.

    • connectorstringread-only

      The user who last connected new credentials for the integration, at credential_update_time. Unset if they were connected by something other than a user, such as a service account.

      Format: users/{user}

    • installLinkValuestring

      The ID of an install link, the last segment of its name, which lets a user who isn’t an admin create an integration of the link’s kind. The link can only be used once.

    • One of

      • oktaOkta
        • clientIdstringrequired

          The client ID issued when the Oblique app is installed from the Okta Integration Network catalog, which Oblique authenticates to Okta as. Required when the integration is created, together with client_secret.

        • clientSecretstringrequired

          The client secret issued alongside client_id when the Oblique app is installed. Required when the integration is created, and never returned by the API; provide it again to rotate.

        • 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.

        • manageResourcesbooleanread-only

          Whether Oblique manages the org’s groups and applications, creating groups and changing membership and assignments, which a resource in push mode needs. False when the connection is read-only, either because read_only holds Oblique to reading or because the Oblique app in Okta wasn’t granted the scopes to manage them. Either way the connection imports users, groups, applications, and their memberships, and writes nothing back to Okta.

        • readOnlyboolean

          Set once, when the resource is created. Whether Oblique asks Okta only for the access to read the org. The Oblique app is installed with the scopes to manage groups and applications, so this keeps a connection read-only without editing the app’s grants in Okta. Set when the integration is created and not editable afterwards: create the integration again to change it.

          Oblique won’t write to Okta while this is set, but it is Oblique’s own setting rather than a limit Okta enforces: the app keeps the scopes it was installed with.

          A connection that leaves this unset can still be read-only, when the Oblique app wasn’t granted those scopes. Either way, manage_resources reports whether the connection writes to Okta.

    • userCountinteger (int32)read-only

      The number of users that the system contains.

    • resourceCountinteger (int32)read-only

      The number of resources that the system manages.

    • accountCountinteger (int32)read-only

      The number of accounts the integration reports, deactivated accounts included. Matches what ListIntegrationAccounts returns for it.

    • attributeCountinteger (int32)read-only

      The number of user attributes the integration syncs.

    • 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.

    • syncsUserAttributesbooleanread-only

      Whether the integration is a source of directory users and the attributes held against them. Only such an integration may be named the source of a core attribute. Reported by the integration’s syncer, so it is unset until the integration has synced once.

    • syncsUserPicturesbooleanread-only

      Whether the integration reports users’ profile photos. Only such an integration may be named the source of profile photos. Reported by the integration’s syncer, so it is unset until the integration has synced once.

    • needsReauthbooleanread-only

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

    • nextSyncTimestring (date-time)read-only

      When Oblique expects to sync the integration again, recorded at the end of every sync. An integration is synced again once its interval has passed, the part of the request budget its last sync spent has come back, and any rate limit that sync hit has reset, so a large organization or a busy API pushes this further out.

      Unset until the integration has synced once, and for the integrations whose syncers don’t report a schedule.

  • nextPageTokenstring

Errors

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