Envoyer des invitations

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Invitations.CreateAsync(
            id: "id",
            request: new CreateOrganizationInvitationRequestContent {
                Inviter = new OrganizationInvitationInviter {
                    Name = "name"
                },
                Invitee = new OrganizationInvitationInvitee {
                    Email = "email"
                },
                ClientId = "client_id"
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateOrganizationInvitationRequestContent{
        Inviter: &management.OrganizationInvitationInviter{
            Name: "name",
        },
        Invitee: &management.OrganizationInvitationInvitee{
            Email: "email",
        },
        ClientId: "client_id",
    }
    mgmt.Organizations.Invitations.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationInvitationRequestContent;
import com.auth0.client.mgmt.types.OrganizationInvitationInvitee;
import com.auth0.client.mgmt.types.OrganizationInvitationInviter;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organizations().invitations().create(
            "id",
            CreateOrganizationInvitationRequestContent
                .builder()
                .inviter(
                    OrganizationInvitationInviter
                        .builder()
                        .name("name")
                        .build()
                )
                .invitee(
                    OrganizationInvitationInvitee
                        .builder()
                        .email("email")
                        .build()
                )
                .clientId("client_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Invitations\Requests\CreateOrganizationInvitationRequestContent;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInviter;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInvitee;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->create(
    'id',
    new CreateOrganizationInvitationRequestContent([
        'inviter' => new OrganizationInvitationInviter([
            'name' => 'name',
        ]),
        'invitee' => new OrganizationInvitationInvitee([
            'email' => 'email',
        ]),
        'clientId' => 'client_id',
    ]),
);

from auth0.management import ManagementClient, OrganizationInvitationInviter, OrganizationInvitationInvitee

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.invitations.create(
    id="id",
    inviter=OrganizationInvitationInviter(
        name="name",
    ),
    invitee=OrganizationInvitationInvitee(
        email="email",
    ),
    client_id="client_id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.organizations.invitations.create(
  id: "id",
  inviter: {
    name: "name"
  },
  invitee: {
    email: "email"
  },
  client_id: "client_id"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "invitee": {
    "email": "john.doe@gmail.com"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "app_metadata": {},
  "connection_id": "con_0000000000000001",
  "roles": [
    "<string>"
  ],
  "send_invitation_email": true,
  "ttl_sec": 1296000,
  "user_metadata": {}
}
'

{
  "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": "john.doe@gmail.com"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "organization_id": "<string>",
  "roles": [
    "<string>"
  ],
  "ticket_id": "<string>",
  "user_metadata": {}
}

POST

https://{tenantDomain}/api/v2

organizations

{id}

invitations

using Auth0.ManagementApi;
using System.Threading.Tasks;
using Auth0.ManagementApi.Organizations;

public partial class Examples
{
    public async Task Example() {
        var client = new ManagementApiClient(
            token: "<token>",
            clientOptions: new ClientOptions { BaseUrl = "https://{YOUR_DOMAIN}/api/v2" }
        );

        await client.Organizations.Invitations.CreateAsync(
            id: "id",
            request: new CreateOrganizationInvitationRequestContent {
                Inviter = new OrganizationInvitationInviter {
                    Name = "name"
                },
                Invitee = new OrganizationInvitationInvitee {
                    Email = "email"
                },
                ClientId = "client_id"
            }
        );
    }

}

package example

import (
    context "context"

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

func do() {
    mgmt, err := client.New(
        "{YOUR_DOMAIN}",
        option.WithToken(
            "<token>",
        ),
    )
    if err != nil {
        return
    }
    request := &management.CreateOrganizationInvitationRequestContent{
        Inviter: &management.OrganizationInvitationInviter{
            Name: "name",
        },
        Invitee: &management.OrganizationInvitationInvitee{
            Email: "email",
        },
        ClientId: "client_id",
    }
    mgmt.Organizations.Invitations.Create(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.CreateOrganizationInvitationRequestContent;
import com.auth0.client.mgmt.types.OrganizationInvitationInvitee;
import com.auth0.client.mgmt.types.OrganizationInvitationInviter;

public class Example {
    public static void main(String[] args) {
        ManagementApi client = ManagementApi
            .builder()
            .domain("{YOUR_DOMAIN}")
            .token("<token>")
            .build();

        client.organizations().invitations().create(
            "id",
            CreateOrganizationInvitationRequestContent
                .builder()
                .inviter(
                    OrganizationInvitationInviter
                        .builder()
                        .name("name")
                        .build()
                )
                .invitee(
                    OrganizationInvitationInvitee
                        .builder()
                        .email("email")
                        .build()
                )
                .clientId("client_id")
                .build()
        );
    }
}

<?php

namespace Example;

use Auth0\SDK\API\Management\Wrapper\ManagementClient;
use Auth0\SDK\API\Management\Wrapper\ManagementClientOptions;
use Auth0\SDK\API\Management\Organizations\Invitations\Requests\CreateOrganizationInvitationRequestContent;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInviter;
use Auth0\SDK\API\Management\Types\OrganizationInvitationInvitee;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->create(
    'id',
    new CreateOrganizationInvitationRequestContent([
        'inviter' => new OrganizationInvitationInviter([
            'name' => 'name',
        ]),
        'invitee' => new OrganizationInvitationInvitee([
            'email' => 'email',
        ]),
        'clientId' => 'client_id',
    ]),
);

from auth0.management import ManagementClient, OrganizationInvitationInviter, OrganizationInvitationInvitee

client = ManagementClient(
    domain="{YOUR_DOMAIN}",
    token="<token>",
)

client.organizations.invitations.create(
    id="id",
    inviter=OrganizationInvitationInviter(
        name="name",
    ),
    invitee=OrganizationInvitationInvitee(
        email="email",
    ),
    client_id="client_id",
)

require "auth0"

client = Auth0::Management.new(token: "<token>", base_url: "https://{YOUR_DOMAIN}/api/v2")

client.organizations.invitations.create(
  id: "id",
  inviter: {
    name: "name"
  },
  invitee: {
    email: "email"
  },
  client_id: "client_id"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.create("id", {
        inviter: {
            name: "name",
        },
        invitee: {
            email: "email",
        },
        clientId: "client_id",
    });
}
main();

curl --request POST \
  --url https://{tenantDomain}/api/v2/organizations/{id}/invitations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "client_id": "AaiyAPdpYdesoKnqjj8HJqRn4T5titww",
  "invitee": {
    "email": "john.doe@gmail.com"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "app_metadata": {},
  "connection_id": "con_0000000000000001",
  "roles": [
    "<string>"
  ],
  "send_invitation_email": true,
  "ttl_sec": 1296000,
  "user_metadata": {}
}
'

{
  "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": "john.doe@gmail.com"
  },
  "inviter": {
    "name": "Jane Doe"
  },
  "organization_id": "<string>",
  "roles": [
    "<string>"
  ],
  "ticket_id": "<string>",
  "user_metadata": {}
}

Autorisations

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

string

requis

Identifiant de l’organisation.

Maximum string length: 50

Corps

client_id

string<client-id>

défaut:AaiyAPdpYdesoKnqjj8HJqRn4T5titww

requis

ID client Auth0. Utilisé pour résoudre le point de terminaison d’initialisation 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 la fonctionnalité de base de l’application.

connection_id

string<connection-id>

défaut:con_0000000000000001

L’ID de la connexion avec laquelle le destinataire de l’invitation doit 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). Valeur par défaut : true.

ttl_sec

integer

Nombre de secondes pendant lesquelles l’invitation est valide avant son expiration. Si aucune valeur n’est précisée ou si elle est définie à 0, cette valeur est fixée par défaut à 604800 secondes (7 jours). Valeur maximale : 2592000 secondes (30 jours).

Plage requise: 0 <= x <= 2592000

user_metadata

object

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

Réponse

Invitation créée avec succès.

app_metadata

object

Données liées à l’utilisateur qui n’affectent pas la fonctionnalité 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’amorçage de connexion de l’application.

connection_id

string<connection-id>

défaut:con_0000000000000001

L’ID de la connexion avec laquelle forcer le destinataire de l’invitation à 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.

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 au destinataire de l’invitation.

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 relatives à l’utilisateur qui n’affectent pas les fonctionnalités de base de l’application.