組織の接続を更新

PATCH https://{tenantDomain}/api/v2/organizations/{id}/connections/{connection_id}

C#

C#

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Connections.UpdateAsync(
            id: "id",
            connectionId: "connection_id",
            request: new UpdateOrganizationConnectionRequestParameters()
        );
    }

}

200

{
  "connection_id": "<string>",
  "assign_membership_on_login": true,
  "connection": {
    "name": "<string>",
    "strategy": "<string>"
  },
  "is_enabled": true,
  "is_signup_enabled": true,
  "organization_connection_name": "<string>",
  "show_as_button": true
}

承認

bearerAuthoAuth2ClientCredentials

Authorization · string · header · 必須

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

パスパラメータ

id · string · 必須

organization 識別子。

Maximum string length: 50

connection_id · string · 必須

接続識別子。

Required string length: 1 - 50

ボディ

application/jsonapplication/x-www-form-urlencoded

assign_membership_on_login · boolean

true の場合、この接続でログインするすべてのユーザーに organization のメンバーシップが自動的に付与されます。false の場合、この接続でログインする前に、ユーザーへ organization のメンバーシップを付与しておく必要があります。

is_enabled · boolean | null

この接続が organization に対して有効かどうか。

is_signup_enabled · boolean

この organization 接続で organization の Signup を有効にするかどうかを決定します。データベース接続にのみ適用されます。デフォルト: false。

organization_access_level · enum<string> | null

organizationのアクセスレベル（例: "none"、"full"）。

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

organization_connection_name · string | null

この organization 内での接続名。

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button · boolean

この接続をこの organization の login prompt に表示するかどうかを決定します。エンタープライズ接続にのみ適用されます。デフォルト: true。

レスポンス

200

application/json

接続を正常に更新しました。

connection_id · string<connection-id> · 必須

接続識別子。

Required string length: 1 - 50

assign_membership_on_login · boolean

true の場合、この接続でログインするすべてのユーザーに organization のメンバーシップが自動的に付与されます。false の場合、この接続でログインする前に、ユーザーへ organization のメンバーシップを付与しておく必要があります。

connection · object

Show child attributes

is_enabled · boolean

この接続が organization に対して有効かどうか。

is_signup_enabled · boolean

この organization 接続で organization の Signup を有効にするかどうかを決定します。データベース接続にのみ適用されます。デフォルト: false。

organization_access_level · enum<string>

organizationのアクセスレベル（例: "none"、"full"）。

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

organization_connection_name · string

この organization 内での接続名。

Required string length: 1 - 50

Pattern: ^[^]*$

show_as_button · boolean

この接続をこの organization の login prompt に表示するかどうかを決定します。エンタープライズ接続にのみ適用されます。デフォルト: true。