• management
• Management
• UpdateOrganizationConnectionRequestParameters

Interface UpdateOrganizationConnectionRequestParameters

Example

{}Copy

interface UpdateOrganizationConnectionRequestParameters {
organization_connection_name?: string | null;
assign_membership_on_login?: boolean;
show_as_button?: boolean;
is_signup_enabled?: boolean;
organization_access_level?:
| Management.OrganizationAccessLevelEnumWithNull
| null;
is_enabled?: boolean
| null;
}

Index

Properties

organization_connection_name?assign_membership_on_login?show_as_button?is_signup_enabled?organization_access_level?is_enabled?

Properties

Optionalorganization_connection_name

organization_connection_name?: string | null

Name of the connection in the scope of this organization.

Optionalassign_membership_on_login

assign_membership_on_login?: boolean

When true, all users that log in with this connection will be automatically granted membership in the organization. When false, users must be granted membership in the organization before logging in with this connection.

Optionalshow_as_button

show_as_button?: boolean

Determines whether a connection should be displayed on this organization’s login prompt. Only applicable for enterprise connections. Default: true.

Optionalis_signup_enabled

is_signup_enabled?: boolean

Determines whether organization signup should be enabled for this organization connection. Only applicable for database connections. Default: false.

Optionalorganization_access_level

organization_access_level?:
| Management.OrganizationAccessLevelEnumWithNull
| null

Optionalis_enabled

is_enabled?: boolean | null

Whether the connection is enabled for the organization.

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties organization_connection_nameassign_membership_on_loginshow_as_buttonis_signup_enabledorganization_access_levelis_enabled