組織のIDプロバイダーを更新

この組織の、ID で指定された IDプロバイダー の詳細を更新します。

PATCH /identity-providers/{idp_id}

IDプロバイダーを更新する

cURL

curl --request PATCH \
  --url https://{tenantDomain}/my-org/v1/identity-providers/{idp_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "assign_membership_on_login": false,
  "display_name": "OIDC IdP",
  "is_enabled": true,
  "options": {
    "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
    "client_secret": "KzQp2sVxR8nTgMjFhYcEWuLoIbDvUoC6A9B1zX7yWqFjHkGrP5sQdLmNp",
    "discovery_url": "https://{yourDomain}/.well-known/openid-configuration",
    "type": "front_channel"
  },
  "show_as_button": true
}
'

200

updateIdPResponseExample

{
  "access_level": "full",
  "assign_membership_on_login": false,
  "attributes": [
    {
      "description": "希望するユーザー名",
      "is_extra": false,
      "is_missing": false,
      "is_required": true,
      "label": "Preferred username",
      "sso_field": [
        "userName"
      ],
      "user_attribute": "preferred_username"
    },
    {
      "is_extra": true,
      "is_missing": false,
      "is_required": true,
      "sso_field": [
        "externalId"
      ],
      "user_attribute": "external_id"
    }
  ],
  "display_name": "OIDC IdP",
  "domains": [
    "mydomain.com"
  ],
  "id": "con_zW1UHutvkVWSWdCC",
  "is_enabled": true,
  "name": "oidcIdp",
  "options": {
    "client_id": "a8f3b2e7-5d1c-4f9a-8b0d-2e1c3a5b6f7d",
    "discovery_url": "https://{yourDomain}/.well-known/openid-configuration",
    "type": "front_channel"
  },
  "show_as_button": true,
  "strategy": "oidc"
}

承認

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

IdP ADFS Update Request

IdP Google Workforce Update Request

IdP OIDC Update Request

IdP Okta Update Request

IdP Ping Update Request

IdP SAML Update Request

IdP Microsoft Azure AD Update Request

assign_membership_on_login · boolean

true の場合、ユーザーはログイン時に組織のメンバーになります。access_level は 'full' または 'limited' である必要があります。

display_name · string

ログイン画面で使用される IDプロバイダー名。access_level は 'full' である必要があります

Required string length: 1 - 128

is_enabled · boolean

IDプロバイダーが組織で有効になっている場合は true。access_level は 'full' または 'limited' である必要があります

show_as_button · boolean

ログインページにこの接続のボタンを表示できるようにします（新しいエクスペリエンスのみ）。false の場合、ホーム レルム ディスカバリー（HRD）でのみ使用できます。access_level は 'full' または 'limited' である必要があります

options · adfs_server · object

IDプロバイダー固有のオプション。access_level は 'full' である必要があります。

adfs_server

fedMetadataXml

Show child attributes

レスポンス

200

application/json

IDプロバイダーが正常に更新されました。

IdP ADFS Response

IdP Google Workforce Response

IdP OIDC Response

IdP Okta Response

IdP Ping Response

IdP SAML Response

IdP Microsoft Azure AD Response

IDプロバイダー固有のオプションです。

strategy · enum<string> · 必須

IDプロバイダーの種類

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

Allowed value: "adfs"

options · adfs_server · object · 必須

IDプロバイダー固有のオプションです。

adfs_server

fedMetadataXml

Show child attributes

access_level · enum<string> · read-only

利用可能なオプション: none, readonly, limited, full

assign_membership_on_login · boolean

true の場合、ユーザーはログイン時に組織のメンバーになります。

display_name · string

ログイン画面で使用される IDプロバイダー名。

Required string length: 1 - 128

domains · string[]

ホーム レルム ディスカバリー（HRD）用のドメイン一覧

id · string · read-only

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

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

is_enabled · boolean

IDプロバイダーが組織で有効になっている場合は true。

name · string | null

IDプロバイダーの名前

Maximum string length: 128

show_as_button · boolean

ログインページにこの接続のボタンを表示できるようにします（新しいエクスペリエンスのみ）。false の場合、ホーム レルム ディスカバリー（HRD）でのみ使用できます。