Interface ConnectionResponseContentSaml

Response for connections with strategy=samlp

interface ConnectionResponseContentSaml {
    authentication?: ConnectionAuthenticationPurpose;
    connected_accounts?: ConnectionConnectedAccountsPurpose;
    display_name: string;
    id: string;
    realms?: ConnectionRealms;
    name: string;
    enabled_clients?: string[];
    is_domain_connection?: boolean;
    metadata?: ConnectionsMetadata;
    strategy: "samlp";
    cross_app_access_resource_app?: ConnectionCrossAppAccessResourceApp | null;
    options?: ConnectionOptionsSaml;
    provisioning_ticket_url?: string;
    show_as_button?: boolean;
}

Hierarchy (View Summary)

ConnectionPurposes
ConnectionResponseCommon
- ConnectionResponseContentSaml

Index

Properties

authentication? connected_accounts? display_name id realms? name enabled_clients? is_domain_connection? metadata? strategy cross_app_access_resource_app? options? provisioning_ticket_url? show_as_button?

Properties

`Optional`authentication

authentication?: ConnectionAuthenticationPurpose

`Optional`connected_accounts

connected_accounts?: ConnectionConnectedAccountsPurpose

display_name

display_name: string

id

id: string

`Optional`realms

realms?: ConnectionRealms

name

name: string

`Optional`enabled_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.

`Optional`is_domain_connection

is_domain_connection?: boolean

`Optional`metadata

metadata?: ConnectionsMetadata

strategy

strategy: "samlp"

`Optional`cross_app_access_resource_app

cross_app_access_resource_app?: ConnectionCrossAppAccessResourceApp | null

`Optional`options

options?: ConnectionOptionsSaml

`Optional`provisioning_ticket_url

provisioning_ticket_url?: string

`Optional`show_as_button

show_as_button?: boolean