Récupérer les invitations par identifiant d’invitation

GET https://{tenantDomain}/api/v2/organizations/{id}/invitations/{invitation_id}

Go

Go

package example

import (
    context "context"

    management "github.com/auth0/go-auth0/management/management"
    client "github.com/auth0/go-auth0/management/management/client"
    option "github.com/auth0/go-auth0/management/management/option"
    organizations "github.com/auth0/go-auth0/management/management/organizations"
)

func do() {
    client := client.NewClient(
        option.WithToken(
            "<token>",
        ),
    )
    request := &organizations.GetOrganizationInvitationRequestParameters{
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
    }
    client.Organizations.Invitations.Get(
        context.TODO(),
        "id",
        "invitation_id",
        request,
    )
}

200

{
  "app_metadata": {},
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "connection_id": "con_0000000000000001",
  "created_at": "2020-08-20T19:10:06.299Z",
  "expires_at": "2020-08-27T19:10:06.299Z",
  "id": "uinv_0000000000000001",
  "invitation_url": "https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme",
  "invitee": {
    "email": "[e-mail]"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "organization_id": "<string>",
  "roles": [
    "<string>"
  ],
  "ticket_id": "<string>",
  "user_metadata": {}
}

Autorisations

bearerAuthoAuth2ClientCredentials

Authorization · string · header · requis

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Paramètres de chemin

id · string · requis

Identifiant de l’organisation.

Maximum string length: 50

invitation_id · string · requis

L’id de l’invitation utilisateur.

Paramètres de requête

fields · string

Liste de champs séparés par des virgules à inclure ou à exclure (selon la valeur fournie pour include_fields) dans le résultat. Laissez ce champ vide pour récupérer tous les champs.

include_fields · boolean

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

Réponse

200

application/json

Invitation récupérée avec succès.

app_metadata · object

Données liées à l’utilisateur qui n’affectent pas les fonctionnalités de base de l’application.

client_id · string<client-id> · défaut: AaiyAPdpYdesoKnqjj8HJqRn4T5titww

ID client Auth0. Utilisé pour résoudre le point de terminaison d’initiation de connexion de l’application.

connection_id · string<connection-id> · défaut: con_0000000000000001

L’id de la connexion avec laquelle forcer la personne invitée à s’authentifier.

created_at · string<date-time> · défaut: 2020-08-20T19:10:06.299Z

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

expires_at · string<date-time> · défaut: 2020-08-27T19:10:06.299Z

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

id · string<user-invitation-id> · défaut: uinv_0000000000000001

L’id de l’invitation utilisateur.

invitation_url · string<strict-https-uri> · défaut: https://mycompany.org/login?invitation=f81dWWYW6gzGGicxT8Ha0txBkGNcAcYr&organization=org_0000000000000001&organization_name=acme

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

invitee · object

Show child attributes

inviter · object

Show child attributes

organization_id · string<organization-id>

Identifiant de l’organisation.

Maximum string length: 50

roles · string<role-id>[]

Liste des ID de rôles à associer à l’utilisateur.

Minimum array length: 1

ticket_id · string<ticket-id>

L’id du ticket d’invitation

user_metadata · object

Données associées à l’utilisateur qui n’affectent pas la fonctionnalité principale de l’application.