Skip to main content
GET
Obtenir une invitation destinée à un membre

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

invitation_id
string
requis
read-only

L’ID de l’invitation du membre

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

Paramètres de requête

fields
string

Liste de champs séparés par des virgules à inclure ou à exclure dans le résultat (selon la valeur fournie pour include_fields). Laissez vide pour récupérer tous les champs. Remarque : vous ne pouvez pas filtrer sur ticket_id, et cette valeur ne sera renvoyée que si les champs ne sont pas filtrés.

Required string length: 1 - 255
Pattern: ^(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url)(,(id|organization_id|inviter|invitee|identity_provider_id|created_at|expires_at|roles|invitation_url))*$
include_fields
boolean
défaut:true

Indique si les champs spécifiés doivent être inclus (true) ou exclus (false). La valeur par défaut est true

Réponse

Obtenir une invitation de membre pour une organisation par ID.

id
string
read-only

L’ID de l’invitation du membre

Pattern: ^uinv_[A-Za-z0-9]{16}$
organization_id
string
read-only

Identifiant de l’organisation.

Pattern: ^org_[A-Za-z0-9]{16}$
inviter
object
invitee
object
identity_provider_id
string
read-only

Identifiant du fournisseur d’identité.

Pattern: ^con_[A-Za-z0-9]{16}$
user_store_id
string
read-only

Identifiant du fournisseur d'identité.

Pattern: ^con_[A-Za-z0-9]{16}$
created_at
string<date-time>

L’horodatage au format ISO 8601 représentant l’heure de création de l’invitation.

expires_at
string<date-time>

L’horodatage au format ISO 8601 représentant l’heure d’expiration de l’invitation.

roles
string[]
read-only

L’ID d’un rôle pouvant être attribué à un membre d’une organisation.

Pattern: ^rol_[A-Za-z0-9]{16}$
invitation_url
string<uri>

L’URL d’invitation à envoyer à la personne invitée.

ticket_id
string

L’ID du ticket d’invitation.