Get Connection Profile Template

Retrieve a Connection Profile Template.

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

Get Connection Profile Template

cURL

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

200

{
  "id": "<string>",
  "display_name": "<string>",
  "template": {
    "name": "<string>",
    "organization": {},
    "connection_name_prefix_template": "<string>",
    "enabled_features": [],
    "connection_config": {},
    "strategy_overrides": {
      "pingfederate": {
        "enabled_features": [],
        "connection_config": {}
      },
      "ad": {
        "enabled_features": [],
        "connection_config": {}
      },
      "adfs": {
        "enabled_features": [],
        "connection_config": {}
      },
      "waad": {
        "enabled_features": [],
        "connection_config": {}
      },
      "google-apps": {
        "enabled_features": [],
        "connection_config": {}
      },
      "okta": {
        "enabled_features": [],
        "connection_config": {}
      },
      "oidc": {
        "enabled_features": [],
        "connection_config": {}
      },
      "samlp": {
        "enabled_features": [],
        "connection_config": {}
      }
    }
  }
}

Authorizations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · required

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

Path Parameters

id · string · required

ID of the connection-profile-template to retrieve.

Response

200

application/json

Connection Profile Template successfully retrieved.

id · string

The id of the template.

display_name · string

The user-friendly name of the template displayed in the UI.

template · object

The structure of the template, which can be used as the payload for creating or updating a Connection Profile.

Show child attributes