Créer des invitations

Créez une invitation utilisateur pour une Organisation précise. Au moment de la création, l’utilisateur indiqué reçoit un courriel l’invitant à rejoindre l’Organisation. Pour en savoir plus sur les invitations d’Organisation, consultez Invite Organization Members.

POST 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.CreateOrganizationInvitationRequestContent{
        Inviter: &management.OrganizationInvitationInviter{
            Name: "name",
        },
        Invitee: &management.OrganizationInvitationInvitee{
            Email: "email",
        },
        ClientId: "client_id",
    }
    client.Organizations.Invitations.Create(
        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.

En-têtes

auth0-custom-domain · string

Domaine personnalisé à utiliser pour cette requête

Required string length: 3 - 255

Paramètres de chemin

id · string · requis

Identifiant de l’organisation.

Maximum string length: 50

Corps

application/jsonapplication/x-www-form-urlencoded

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

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

invitee · object · requis

Show child attributes

inviter · object · requis

Show child attributes

app_metadata · object

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

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

L’id de la connexion à utiliser pour forcer l’invité à s’authentifier.

roles · string<role-id>[]

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

Minimum array length: 1

send_invitation_email · boolean · défaut: true

Indique si l’utilisateur recevra un courriel d’invitation (true) ou aucun courriel (false), true par défaut.

ttl_sec · integer

Nombre de secondes pendant lesquelles l’invitation est valide avant expiration. S’il n’est pas précisé ou s’il est défini sur 0, ce champ prend par défaut la valeur 604800 secondes (7 jours). Valeur maximale : 2592000 secondes (30 jours).

Plage requise: 0 <= x <= 2592000

user_metadata · object

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

Réponse

200

application/json

Invitation créé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 déterminer 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 à utiliser pour forcer l’invité à s’authentifier.

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

L’horodatage au format ISO 8601 représentant 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 l’heure 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 à l’invité.

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.