Class InvitationsClient

Namespace

Auth0.ManagementApi.Organizations

Assembly

Auth0.ManagementApi.dll

public class InvitationsClient : IInvitationsClient

Inheritance

object

InvitationsClient

Implements

IInvitationsClient

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

OptionalExtensions.AddIfNotNull<T>(T?, Dictionary<string, object?>, string)

Methods

CreateAsync(string, CreateOrganizationInvitationRequestContent, RequestOptions?, CancellationToken)

Create a user invitation for a specific Organization. Upon creation, the listed user receives an email inviting them to join the Organization. To learn more about Organization invitations, review Invite Organization Members.

public WithRawResponseTask<CreateOrganizationInvitationResponseContent> CreateAsync(string id, CreateOrganizationInvitationRequestContent request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request CreateOrganizationInvitationRequestContent

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<CreateOrganizationInvitationResponseContent>

Examples

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

DeleteAsync(string, string, RequestOptions?, CancellationToken)

public Task DeleteAsync(string id, string invitationId, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

invitationId string

options RequestOptions

cancellationToken CancellationToken

Returns

Task

Examples

await client.Organizations.Invitations.DeleteAsync("id", "invitation_id");

GetAsync(string, string, GetOrganizationInvitationRequestParameters, RequestOptions?, CancellationToken)

public WithRawResponseTask<GetOrganizationInvitationResponseContent> GetAsync(string id, string invitationId, GetOrganizationInvitationRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

invitationId string

request GetOrganizationInvitationRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

WithRawResponseTask<GetOrganizationInvitationResponseContent>

Examples

await client.Organizations.Invitations.GetAsync(
    "id",
    "invitation_id",
    new GetOrganizationInvitationRequestParameters { Fields = "fields", IncludeFields = true }
);

ListAsync(string, ListOrganizationInvitationsRequestParameters, RequestOptions?, CancellationToken)

Retrieve a detailed list of invitations sent to users for a specific Organization. The list includes details such as inviter and invitee information, invitation URLs, and dates of creation and expiration. To learn more about Organization invitations, review Invite Organization Members.

public Task<Pager<OrganizationInvitation>> ListAsync(string id, ListOrganizationInvitationsRequestParameters request, RequestOptions? options = null, CancellationToken cancellationToken = default)

Parameters

id string

request ListOrganizationInvitationsRequestParameters

options RequestOptions

cancellationToken CancellationToken

Returns

Task<Pager<OrganizationInvitation>>

Examples

await client.Organizations.Invitations.ListAsync(
    "id",
    new ListOrganizationInvitationsRequestParameters
    {
        Page = 1,
        PerPage = 1,
        IncludeTotals = true,
        Fields = "fields",
        IncludeFields = true,
        Sort = "sort",
    }
);