Skip to content
Oblique Docs

GetIntegration

GET/api/v1/integrations/{integration}

Fetch an integration by name.

Example request

Section titled “Example request”
curl \
  -H "Authorization: Bearer ${OBLIQUE_API_KEY}" \
  "https://us.oblique.security/api/v1/integrations/{integration}"

Set OBLIQUE_API_KEY to your API key.

Path parameters

Section titled “Path parameters”
  • namestringrequired

    Name of the integration of the format integrations/{id}.

Response

Section titled “Response”
200Integration

Integrations connect Oblique with external systems in your organization. Oblique can both pull information from and push access decisions back to integrations.

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

  • One of

    • oktaOkta
      • apiTokenstring

        The API token to use when making calls to Okta. Either this or OAuth2 client credentials must be provided when the integration is created.

      • clientIdstring

        The client ID issued when the Oblique app is installed from the Okta Integration Network catalog. Must be provided together with client_secret, and can’t be combined with api_token: an integration authenticates either with OAuth2 client credentials or with an API token.

      • clientSecretstring

        The client secret issued alongside client_id when the Oblique app is installed. Must be provided together with client_id, and can’t be combined with api_token. 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. Revoke the management scopes from the Oblique app in Okta for a limit the org enforces, which Oblique reports the same way, by leaving manage_resources false.

        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.

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

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

  • needsReauthbooleanread-only

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

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