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.ListAsync(
            id: "id",
            request: new ListOrganizationInvitationsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Fields = "fields",
                IncludeFields = true,
                Sort = "sort"
            }
        );
    }

}

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.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",
        ),
    }
    mgmt.Organizations.Invitations.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.ListOrganizationInvitationsRequestParameters;

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

        client.organizations().invitations().list(
            "id",
            ListOrganizationInvitationsRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .fields("fields")
                .includeFields(true)
                .sort("sort")
                .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\ListOrganizationInvitationsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->list(
    'id',
    new ListOrganizationInvitationsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'fields' => 'fields',
        'includeFields' => true,
        'sort' => 'sort',
    ]),
);

from auth0.management import ManagementClient

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

client.organizations.invitations.list(
    id="id",
    page=1,
    per_page=1,
    include_totals=True,
    fields="fields",
    include_fields=True,
    sort="sort",
)

require "auth0"

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

client.organizations.invitations.list(
  id: "id",
  page: 1,
  per_page: 1,
  include_totals: true,
  fields: "fields",
  include_fields: true,
  sort: "sort"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
        fields: "fields",
        includeFields: true,
        sort: "sort",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
        fields: "fields",
        includeFields: true,
        sort: "sort",
    });
}
main();

[
  {
    "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": {}
  }
]

Obtenir les invitations

deprecated

Récupère une liste détaillée des invitations envoyées aux utilisateurs pour une organisation précise. La liste comprend notamment les renseignements sur l’expéditeur et le destinataire de l’invitation, 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

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.ListAsync(
            id: "id",
            request: new ListOrganizationInvitationsRequestParameters {
                Page = 1,
                PerPage = 1,
                IncludeTotals = true,
                Fields = "fields",
                IncludeFields = true,
                Sort = "sort"
            }
        );
    }

}

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.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",
        ),
    }
    mgmt.Organizations.Invitations.List(
        context.TODO(),
        "id",
        request,
    )
}

package com.example.usage;

import com.auth0.client.mgmt.ManagementApi;
import com.auth0.client.mgmt.organizations.types.ListOrganizationInvitationsRequestParameters;

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

        client.organizations().invitations().list(
            "id",
            ListOrganizationInvitationsRequestParameters
                .builder()
                .page(1)
                .perPage(1)
                .includeTotals(true)
                .fields("fields")
                .includeFields(true)
                .sort("sort")
                .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\ListOrganizationInvitationsRequestParameters;

$client = new ManagementClient(new ManagementClientOptions(
    domain: '{YOUR_DOMAIN}',
    token: '<token>',
));
$client->organizations->invitations->list(
    'id',
    new ListOrganizationInvitationsRequestParameters([
        'page' => 1,
        'perPage' => 1,
        'includeTotals' => true,
        'fields' => 'fields',
        'includeFields' => true,
        'sort' => 'sort',
    ]),
);

from auth0.management import ManagementClient

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

client.organizations.invitations.list(
    id="id",
    page=1,
    per_page=1,
    include_totals=True,
    fields="fields",
    include_fields=True,
    sort="sort",
)

require "auth0"

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

client.organizations.invitations.list(
  id: "id",
  page: 1,
  per_page: 1,
  include_totals: true,
  fields: "fields",
  include_fields: true,
  sort: "sort"
)

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
        fields: "fields",
        includeFields: true,
        sort: "sort",
    });
}
main();

import { ManagementClient } from "auth0";

async function main() {
    const client = new ManagementClient({
        domain: "{YOUR_DOMAIN}",
        token: "<token>",
    });
    await client.organizations.invitations.list("id", {
        page: 1,
        perPage: 1,
        includeTotals: true,
        fields: "fields",
        includeFields: true,
        sort: "sort",
    });
}
main();

[
  {
    "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.

Paramètres de chemin

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 true, renvoie les résultats dans un objet qui contient aussi le début et la limite. Lorsque false (par défaut), un tableau de résultats est renvoyé directement. Nous ne prenons pas encore en charge le renvoi du nombre total d’invitations.

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 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 à utiliser pour le tri. Utilisez champ:ordre, où ordre vaut 1 pour un tri croissant et -1 pour un tri décroissant. La valeur par défaut est created_at:-1.

Réponse

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

object[]
object

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