Skip to main content
PATCH
/
connection-profiles
/
{id}
Modify a Connection Profile
curl --request PATCH \
  --url https://{tenantDomain}/api/v2/connection-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "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": {}
    }
  }
}
'
{
  "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": {}
    }
  }
}

Authorizations

​
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 to update.

Body

​
name
string

The name of the connection profile.

Required string length: 1 - 50
​
organization
object

The organization of the connection profile.

​
connection_name_prefix_template
string

Connection name prefix template.

Maximum string length: 15
Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$
​
enabled_features
enum<string>[]

Enabled features for the connection profile.

Enum for enabled features.

Available options:
scim,
universal_logout
​
connection_config
object

Connection profile configuration.

​
strategy_overrides
object

Strategy-specific overrides for this attribute

Response

Connection profile successfully updated.

​
id
string<connection-profile-id>

Connection Profile identifier.

​
name
string

The name of the connection profile.

Required string length: 1 - 50
​
organization
object

The organization of the connection profile.

​
connection_name_prefix_template
string

Connection name prefix template.

Maximum string length: 15
Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$
​
enabled_features
enum<string>[]

Enabled features for the connection profile.

Enum for enabled features.

Available options:
scim,
universal_logout
​
connection_config
object

Connection profile configuration.

​
strategy_overrides
object

Strategy-specific overrides for this attribute