Récupérer les invitations

Récupérez une liste détaillée des invitations envoyées aux utilisateurs pour une Organisation précise. La liste comprend notamment des renseignements sur l’invitant et l’invité, les URL d’invitation ainsi que les dates de création et d’expiration. Pour en savoir plus sur les invitations d’Organisation, consultez Invite Organization Members.

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

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.ListOrganizationInvitationsRequestParameters{
        Page: management.Int(
            1,
        ),
        PerPage: management.Int(
            1,
        ),
        IncludeTotals: management.Bool(
            true,
        ),
        Fields: management.String(
            "fields",
        ),
        IncludeFields: management.Bool(
            true,
        ),
        Sort: management.String(
            "sort",
        ),
    }
    client.Organizations.Invitations.List(
        context.TODO(),
        "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

Paramètres de requête

page · integer

Indice de la page de résultats à renvoyer. La première page est 0.

Plage requise: x >= 0

per_page · integer

Nombre de résultats par page. La valeur par défaut est 50.

Plage requise: 1 <= x <= 100

include_totals · boolean

Lorsque la valeur est true, les résultats sont renvoyés dans un objet qui contient aussi start et limit. Lorsque la valeur est false (par défaut), un tableau de résultats est renvoyé directement. Le renvoi du nombre total d’invitations n’est pas encore pris en charge.

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 précisés doivent être inclus (true) ou exclus (false). La valeur par défaut est true.

sort · string

Champ de tri. Utilisez field:order, où order vaut 1 pour l’ordre croissant et -1 pour l’ordre décroissant. La valeur par défaut est created_at:-1.

Réponse

200

application/json

Invitations récupérées avec succès.

object[]

object

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’initialisation 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 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 d’expiration de l’invitation.

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

L’id de l’invitation de l’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.