• management
• Management
• EventStreamCloudEventConnectionCreatedObject3

Interface EventStreamCloudEventConnectionCreatedObject3

interface EventStreamCloudEventConnectionCreatedObject3 {
authentication?: EventStreamCloudEventConnectionCreatedObject3Authentication;
connected_accounts?: EventStreamCloudEventConnectionCreatedObject3ConnectedAccounts;
display_name?: string;
enabled_clients?: string[];
id: string;
is_domain_connection?: boolean;
metadata?: EventStreamCloudEventConnectionCreatedObject3Metadata;
name: string;
realms?: string[];
options?: EventStreamCloudEventConnectionCreatedObject3Options;
show_as_button?: boolean;
strategy: "pingfederate";
}

Index

Properties

authentication?connected_accounts?display_name?enabled_clients?idis_domain_connection?metadata?namerealms?options?show_as_button?strategy

Properties

Optionalauthentication

authentication?: EventStreamCloudEventConnectionCreatedObject3Authentication

Optionalconnected_accounts

connected_accounts?: EventStreamCloudEventConnectionCreatedObject3ConnectedAccounts

Optionaldisplay_name

display_name?: string

Connection name used in the new universal login experience

Optionalenabled_clients

enabled_clients?: string[]

Use of this property is NOT RECOMMENDED. Use the PATCH /v2/connections/{id}/clients endpoint to enable the connection for a set of clients.

id

id: string

The connection's identifier

Optionalis_domain_connection

is_domain_connection?: boolean

true promotes to a domain-level connection so that third-party applications can use it. false does not promote the connection, so only first-party applications with the connection enabled can use it. (Defaults to false.)

Optionalmetadata

metadata?: EventStreamCloudEventConnectionCreatedObject3Metadata

name

name: string

The name of the connection. Must start and end with an alphanumeric character and can only contain alphanumeric characters and '-'. Max length 128

Optionalrealms

realms?: string[]

Defines the realms for which the connection will be used (ie: email domains). If the array is empty or the property is not specified, the connection name will be added as realm.

Optionaloptions

options?: EventStreamCloudEventConnectionCreatedObject3Options

Optionalshow_as_button

show_as_button?: boolean

Enables showing a button for the connection in the login page (new experience only). If false, it will be usable only by HRD. Defaults to false.

strategy

strategy: "pingfederate"

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties authenticationconnected_accountsdisplay_nameenabled_clientsidis_domain_connectionmetadatanamerealmsoptionsshow_as_buttonstrategy