Get Connection Profiles

Retrieve a list of Connection Profiles. This endpoint supports Checkpoint pagination.

GET https://{tenantDomain}/api/v2/connection-profiles

Get Connection Profiles

cURL

curl --request GET \
  --url https://{tenantDomain}/api/v2/connection-profiles \
  --header 'Authorization: Bearer <token>'

200

{
  "next": "<string>",
  "connection_profiles": [
    {
      "id": "<string>",
      "name": "<string>",
      "organization": {
        "show_as_button": "none",
        "assign_membership_on_login": "none"
      },
      "connection_name_prefix_template": "<string>",
      "enabled_features": [
        "scim"
      ],
      "connection_config": {},
      "strategy_overrides": {
        "pingfederate": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        },
        "ad": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        },
        "adfs": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        },
        "waad": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        },
        "google-apps": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        },
        "okta": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        },
        "oidc": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        },
        "samlp": {
          "enabled_features": [
            "scim"
          ],
          "connection_config": {}
        }
      }
    }
  ]
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de requête

from · string

Optional Id from which to start selection.

take · integer

Number of results per page. Defaults to 5.

Plage requise: 1 <= x <= 10

Réponse

200

application/json

Connection Profiles successfully retrieved.

next · string

A cursor to be used as the "from" query parameter for the next page of results.

connection_profiles · object[]

Show child attributes