IdP のプロビジョニング設定属性を更新

この組織の、ID で指定された IDプロバイダー のプロビジョニング構成の属性マッピングを更新します。マッピングは管理者が定義したデフォルトにリセットされます。

PUT /identity-providers/{idp_id}/provisioning/update-attributes

プロビジョニング設定の属性マッピングを更新する

cURL

curl --request PUT \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id}/provisioning/update-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{}'

200

getIdPResponseExample

{
  "attributes": [
    {
      "description": "希望するユーザー名",
      "is_extra": false,
      "is_missing": false,
      "is_required": true,
      "label": "Preferred username",
      "provisioning_field": "userName",
      "user_attribute": "preferred_username"
    },
    {
      "is_extra": false,
      "is_missing": false,
      "is_required": true,
      "provisioning_field": "active",
      "user_attribute": "blocked"
    }
  ],
  "created_at": "2025-05-15T23:32:52.351Z",
  "identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
  "identity_provider_name": "EC-org-gaZPTTOS42pReSzs-id-ready2",
  "method": "scim",
  "strategy": "okta",
  "updated_on": "2025-05-15T23:32:52.351Z",
  "user_id_attribute": "externalId"
}

承認

OAuth2ClientCredentialsOAuth2AuthCode

Authorization · string · header · 必須

The access token received from the authorization server in the OAuth 2.0 flow.

パスパラメータ

idp_id · string · 必須 · read-only

IDプロバイダーの識別子。

Pattern: ^con_[A-Za-z0-9]{16}$

ボディ

application/json

The body is of type object.

レスポンス

200

application/json

プロビジョニング設定が正常に取得されました。

attributes · object[] · 必須

Show child attributes

identity_provider_id · string · 必須 · read-only

IDプロバイダーの識別子。

Pattern: ^con_[A-Za-z0-9]{16}$

identity_provider_name · string · 必須 · read-only

IDプロバイダーの名前

Required string length: 1 - 128

method · enum<string> · 必須

IDプロバイダーのプロビジョニング方法のタイプ

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

strategy · enum<string> · 必須

IDプロバイダーの種類

利用可能なオプション: adfs, google-apps, oidc, okta, pingfederate, samlp, waad

user_id_attribute · string · 必須

ユーザーのID

created_at · string<date-time> · 必須

updated_on · string<date-time> · 必須