Passer au contenu principal
GET
TypeScript

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Paramètres de chemin

idp_id
string
requis
read-only

Identifiant du fournisseur d’identité.

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

Réponse

Fournisseur d’identité récupéré avec succès.

Options spécifiques au fournisseur d’identité.

strategy
enum<string>
requis

Le type de fournisseur d’identité

Options disponibles:
adfs,
google-apps,
oidc,
okta,
pingfederate,
samlp,
waad
Allowed value: "adfs"
id
string
read-only

Identifiant du fournisseur d’identité.

Pattern: ^con_[A-Za-z0-9]{16}$
name
string | null

Le nom du fournisseur d’identité

Maximum string length: 128
domains
string[]

Liste des domaines pour Home Realm Discovery (HRD)

display_name
string

Nom du fournisseur d’identité utilisé sur l’écran de connexion.

Required string length: 1 - 128
show_as_button
boolean

Permet d’afficher un bouton pour la connexion sur la page de connexion (nouvelle expérience seulement). Si false, elle pourra être utilisée uniquement par Home Realm Discovery (HRD).

assign_membership_on_login
boolean

Si true, l’utilisateur deviendra membre de l’organisation lors de la connexion.

is_enabled
boolean

True si le fournisseur d’identité est activé pour l’organisation.

access_level
enum<string>
read-only

Le niveau d’accès autorisé pour l’Organisation

Options disponibles:
none,
readonly,
limited,
full
member_access_level
enum<string>
read-only
EA

Le niveau d’accès des membres de l’Organization pour cette connexion.

Options disponibles:
none,
readonly,
limited,
full
use_for_third_party_client_access
boolean

Vrai si les applications tierces peuvent l'utiliser. Si faux, seules les applications propriétaires pour lesquelles la connexion est activée peuvent l'utiliser. La valeur par défaut est faux.

cross_app_access_resource_app
object
EA

Configuration de l'application de ressources d'accès interapplications. Présente uniquement lorsque la fonctionnalité d'application de ressources d'accès interapplications est activée pour votre organisation.

options
adfs_server · object

Options spécifiques au fournisseur d’identité.