id で接続プロファイルを更新

特定の接続プロファイルの詳細を更新します。

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

接続プロファイルを変更

cURL

curl --request PATCH \
  --url https://{tenantDomain}/api/v2/connection-profiles/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection_config": {},
  "connection_name_prefix_template": "<string>",
  "enabled_features": [],
  "name": "<string>",
  "organization": {},
  "strategy_overrides": {
    "ad": {
      "connection_config": {},
      "enabled_features": []
    },
    "adfs": {
      "connection_config": {},
      "enabled_features": []
    },
    "google-apps": {
      "connection_config": {},
      "enabled_features": []
    },
    "oidc": {
      "connection_config": {},
      "enabled_features": []
    },
    "okta": {
      "connection_config": {},
      "enabled_features": []
    },
    "pingfederate": {
      "connection_config": {},
      "enabled_features": []
    },
    "samlp": {
      "connection_config": {},
      "enabled_features": []
    },
    "waad": {
      "connection_config": {},
      "enabled_features": []
    }
  }
}
'

200

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

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

更新する接続プロファイルの ID。

ボディ

application/jsonapplication/x-www-form-urlencoded

connection_config · object

接続プロファイルの設定。

connection_name_prefix_template · string

接続名のプレフィックステンプレート。

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

接続プロファイルで有効な機能。

有効な機能の列挙型。

利用可能なオプション: scim, universal_logout

name · string

接続プロファイルの名前。

Required string length: 1 - 50

organization · object

接続プロファイルの組織。

Show child attributes

strategy_overrides · object

この属性に対するストラテジー固有のオーバーライド

Show child attributes

レスポンス

200

application/json

接続プロファイルを正常に更新しました。

connection_config · object

接続プロファイルの設定。

connection_name_prefix_template · string

接続名のプレフィックステンプレート。

Maximum string length: 15

Pattern: ^(?!-)(?!.*--)(?:[a-zA-Z0-9-]|{org_id}|{org_name})*$

enabled_features · enum<string>[]

接続プロファイルで有効な機能。

有効な機能の列挙型。

利用可能なオプション: scim, universal_logout

id · string<connection-profile-id>

接続プロファイルの識別子。

name · string

接続プロファイルの名前。

Required string length: 1 - 50

organization · object

接続プロファイルの組織。

Show child attributes

strategy_overrides · object

この属性に対するストラテジー固有のオーバーライド

Show child attributes