ID を指定してユーザー属性プロファイルを部分更新

name、user_id、user_attributes など、特定のユーザー属性プロファイルの詳細を更新します。

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

ユーザー属性プロファイルを更新

cURL

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

200

{
  "id": "<string>",
  "name": "<string>",
  "user_attributes": {},
  "user_id": {
    "saml_mapping": [
      "<string>"
    ],
    "scim_mapping": "<string>",
    "strategy_overrides": {
      "ad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "adfs": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "google-apps": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "oidc": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "okta": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "pingfederate": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "samlp": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      },
      "waad": {
        "saml_mapping": [
          "<string>"
        ],
        "scim_mapping": "<string>"
      }
    }
  }
}

承認

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

name · string

ユーザー属性プロファイルの名前。

Required string length: 1 - 128

user_attributes · object

ユーザー属性の設定マップ。キーは属性名、値は各属性のマッピング設定です。

Show child attributes

user_id · object

ユーザー ID のマッピング設定

Show child attributes

レスポンス

200

application/json

ユーザー属性プロファイルが正常に更新されました。

id · string<user-attribute-profile-id>

ユーザー属性プロファイルの識別子。

name · string

ユーザー属性プロファイルの名前。

Required string length: 1 - 128

user_attributes · object

ユーザー属性の設定マップ。キーは属性名、値は各属性のマッピング設定です。

Show child attributes

user_id · object

ユーザー ID のマッピング設定

Show child attributes