TypeScript
import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organization.invitations.create({
invitees: [
{
email: "user@example.com",
roles: [
"rol_0000000000000001",
],
},
],
inviter: {
name: "Allison the Admin",
},
identity_provider_id: "con_2CZPv6IY0gWzDaQJ",
ttl_sec: 3600,
});
}
main();import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organization.invitations.create({
invitees: [
{
email: "user@example.com",
roles: [
"rol_0000000000000001",
],
},
],
inviter: {
name: "Allison the Admin",
},
identity_provider_id: "con_2CZPv6IY0gWzDaQJ",
ttl_sec: 3600,
});
}
main();
package example
import (
context "context"
myorganization "github.com/auth0/myorganization-go/v2"
client "github.com/auth0/myorganization-go/v2/client"
option "github.com/auth0/myorganization-go/v2/option"
)
func do() {
c, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &myorganization.CreateMemberInvitationRequestContent{
Invitees: []*myorganization.CreateMemberInvitationInvitee{
&myorganization.CreateMemberInvitationInvitee{
Email: "user@example.com",
Roles: []myorganization.RoleID{
"rol_0000000000000001",
},
},
},
Inviter: &myorganization.MemberInvitationInviter{
Name: myorganization.String(
"Allison the Admin",
),
},
IdentityProviderID: myorganization.String(
"con_2CZPv6IY0gWzDaQJ",
),
TTLSec: myorganization.Int(
3600,
),
}
c.Organization.Invitations.Create(
context.TODO(),
request,
)
}
using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization;
using System.Collections.Generic;
public partial class Examples
{
public async Task Example() {
var client = new MyOrganizationClient(new MyOrganizationClientOptions
{
Domain = "{YOUR_DOMAIN}",
TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
});
await client.Organization.Invitations.CreateAsync(
new CreateMemberInvitationRequestContent {
Invitees = new List<CreateMemberInvitationInvitee>(){
new CreateMemberInvitationInvitee {
Email = "user@example.com",
Roles = new List<string>(){
"rol_0000000000000001",
}
},
}
,
Inviter = new MemberInvitationInviter {
Name = "Allison the Admin"
},
IdentityProviderId = "con_2CZPv6IY0gWzDaQJ",
TtlSec = 3600
}
);
}
}
package com.example.usage;
import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.types.CreateMemberInvitationRequestContent;
import com.auth0.client.myorganization.types.CreateMemberInvitationInvitee;
import com.auth0.client.myorganization.types.MemberInvitationInviter;
import java.util.Arrays;
import java.util.Optional;
public class Example {
public static void main(String[] args) {
MyOrganizationClient client = MyOrganizationClient
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.organization().invitations().create(
CreateMemberInvitationRequestContent
.builder()
.invitees(
Arrays.asList(
CreateMemberInvitationInvitee
.builder()
.email("user@example.com")
.roles(
Optional.of(
Arrays.asList("rol_0000000000000001")
)
)
.build()
)
)
.inviter(
MemberInvitationInviter
.builder()
.name("Allison the Admin")
.build()
)
.identityProviderId("con_2CZPv6IY0gWzDaQJ")
.ttlSec(3600)
.build()
);
}
}from auth0.myorganization import MyOrganizationClient, CreateMemberInvitationInvitee, MemberInvitationInviter
client = MyOrganizationClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.organization.invitations.create(
invitees=[
CreateMemberInvitationInvitee(
email="user@example.com",
roles=[
"rol_0000000000000001"
],
)
],
inviter=MemberInvitationInviter(
name="Allison the Admin",
),
identity_provider_id="con_2CZPv6IY0gWzDaQJ",
ttl_sec=3600,
)
curl --request POST \
--url https://{tenantDomain}/my-org/v1/member-invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invitees": [
{
"email": "user@example.com",
"roles": [
"rol_0000000000000001"
]
}
],
"inviter": {
"name": "Allison the Admin"
},
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"ttl_sec": 3600
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenantDomain}/my-org/v1/member-invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'invitees' => [
[
'email' => 'user@example.com',
'roles' => [
'rol_0000000000000001'
]
]
],
'inviter' => [
'name' => 'Allison the Admin'
],
'identity_provider_id' => 'con_2CZPv6IY0gWzDaQJ',
'ttl_sec' => 3600
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}/my-org/v1/member-invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"ttl_sec\": 3600\n}"
response = http.request(request)
puts response.read_body[
{
"id": "uinv_12345678abcdefgh",
"organization_id": "org_12345678abcdefgh",
"inviter": {
"name": "Allison the Admin"
},
"invitee": {
"email": "user@example.com"
},
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"created_at": "2025-04-11T20:11:45.431Z",
"expires_at": "2025-04-11T20:11:45.431Z",
"roles": [
"rol_BKW1BKIfBKd0BaI0"
],
"invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
"ticket_id": "1asdfasd23usjdef"
}
]Create member invitations
Create one or more member invitations for this Organization. If an active invitation already exists for a user, generating a new invitation will automatically revoke any outstanding invitations for that user. Roles specified in the payload will be granted to the user upon acceptance of the invitation.
POST
/
member-invitations
TypeScript
import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organization.invitations.create({
invitees: [
{
email: "user@example.com",
roles: [
"rol_0000000000000001",
],
},
],
inviter: {
name: "Allison the Admin",
},
identity_provider_id: "con_2CZPv6IY0gWzDaQJ",
ttl_sec: 3600,
});
}
main();import { MyOrganizationClient } from "@auth0/myorganization-js";
async function main() {
const client = new MyOrganizationClient({
domain: "{YOUR_DOMAIN}",
token: "<token>",
});
await client.organization.invitations.create({
invitees: [
{
email: "user@example.com",
roles: [
"rol_0000000000000001",
],
},
],
inviter: {
name: "Allison the Admin",
},
identity_provider_id: "con_2CZPv6IY0gWzDaQJ",
ttl_sec: 3600,
});
}
main();
package example
import (
context "context"
myorganization "github.com/auth0/myorganization-go/v2"
client "github.com/auth0/myorganization-go/v2/client"
option "github.com/auth0/myorganization-go/v2/option"
)
func do() {
c, err := client.New(
"{YOUR_DOMAIN}",
option.WithToken(
"<token>",
),
)
if err != nil {
return
}
request := &myorganization.CreateMemberInvitationRequestContent{
Invitees: []*myorganization.CreateMemberInvitationInvitee{
&myorganization.CreateMemberInvitationInvitee{
Email: "user@example.com",
Roles: []myorganization.RoleID{
"rol_0000000000000001",
},
},
},
Inviter: &myorganization.MemberInvitationInviter{
Name: myorganization.String(
"Allison the Admin",
),
},
IdentityProviderID: myorganization.String(
"con_2CZPv6IY0gWzDaQJ",
),
TTLSec: myorganization.Int(
3600,
),
}
c.Organization.Invitations.Create(
context.TODO(),
request,
)
}
using Auth0.MyOrganizationApi;
using System.Threading.Tasks;
using Auth0.MyOrganizationApi.Organization;
using System.Collections.Generic;
public partial class Examples
{
public async Task Example() {
var client = new MyOrganizationClient(new MyOrganizationClientOptions
{
Domain = "{YOUR_DOMAIN}",
TokenProvider = new DelegateTokenProvider(_ => Task.FromResult("<token>"))
});
await client.Organization.Invitations.CreateAsync(
new CreateMemberInvitationRequestContent {
Invitees = new List<CreateMemberInvitationInvitee>(){
new CreateMemberInvitationInvitee {
Email = "user@example.com",
Roles = new List<string>(){
"rol_0000000000000001",
}
},
}
,
Inviter = new MemberInvitationInviter {
Name = "Allison the Admin"
},
IdentityProviderId = "con_2CZPv6IY0gWzDaQJ",
TtlSec = 3600
}
);
}
}
package com.example.usage;
import com.auth0.client.myorganization.auth.MyOrganizationClient;
import com.auth0.client.myorganization.organization.types.CreateMemberInvitationRequestContent;
import com.auth0.client.myorganization.types.CreateMemberInvitationInvitee;
import com.auth0.client.myorganization.types.MemberInvitationInviter;
import java.util.Arrays;
import java.util.Optional;
public class Example {
public static void main(String[] args) {
MyOrganizationClient client = MyOrganizationClient
.builder()
.domain("{YOUR_DOMAIN}")
.token("<token>")
.build();
client.organization().invitations().create(
CreateMemberInvitationRequestContent
.builder()
.invitees(
Arrays.asList(
CreateMemberInvitationInvitee
.builder()
.email("user@example.com")
.roles(
Optional.of(
Arrays.asList("rol_0000000000000001")
)
)
.build()
)
)
.inviter(
MemberInvitationInviter
.builder()
.name("Allison the Admin")
.build()
)
.identityProviderId("con_2CZPv6IY0gWzDaQJ")
.ttlSec(3600)
.build()
);
}
}from auth0.myorganization import MyOrganizationClient, CreateMemberInvitationInvitee, MemberInvitationInviter
client = MyOrganizationClient(
domain="{YOUR_DOMAIN}",
token="<token>",
)
client.organization.invitations.create(
invitees=[
CreateMemberInvitationInvitee(
email="user@example.com",
roles=[
"rol_0000000000000001"
],
)
],
inviter=MemberInvitationInviter(
name="Allison the Admin",
),
identity_provider_id="con_2CZPv6IY0gWzDaQJ",
ttl_sec=3600,
)
curl --request POST \
--url https://{tenantDomain}/my-org/v1/member-invitations \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"invitees": [
{
"email": "user@example.com",
"roles": [
"rol_0000000000000001"
]
}
],
"inviter": {
"name": "Allison the Admin"
},
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"ttl_sec": 3600
}
'<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{tenantDomain}/my-org/v1/member-invitations",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'invitees' => [
[
'email' => 'user@example.com',
'roles' => [
'rol_0000000000000001'
]
]
],
'inviter' => [
'name' => 'Allison the Admin'
],
'identity_provider_id' => 'con_2CZPv6IY0gWzDaQJ',
'ttl_sec' => 3600
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}require 'uri'
require 'net/http'
url = URI("https://{tenantDomain}/my-org/v1/member-invitations")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"invitees\": [\n {\n \"email\": \"user@example.com\",\n \"roles\": [\n \"rol_0000000000000001\"\n ]\n }\n ],\n \"inviter\": {\n \"name\": \"Allison the Admin\"\n },\n \"identity_provider_id\": \"con_2CZPv6IY0gWzDaQJ\",\n \"ttl_sec\": 3600\n}"
response = http.request(request)
puts response.read_body[
{
"id": "uinv_12345678abcdefgh",
"organization_id": "org_12345678abcdefgh",
"inviter": {
"name": "Allison the Admin"
},
"invitee": {
"email": "user@example.com"
},
"identity_provider_id": "con_2CZPv6IY0gWzDaQJ",
"created_at": "2025-04-11T20:11:45.431Z",
"expires_at": "2025-04-11T20:11:45.431Z",
"roles": [
"rol_BKW1BKIfBKd0BaI0"
],
"invitation_url": "https://example.auth0.com/login?invitation=uinv_12345678abcdefgh&organization=org_12345678abcdefgh",
"ticket_id": "1asdfasd23usjdef"
}
]Authorizations
OAuth2ClientCredentialsOAuth2AuthCode
The access token received from the authorization server in the OAuth 2.0 flow.
Headers
Body
application/json
Required array length:
1 - 10 elementsShow child attributes
Show child attributes
Show child attributes
Show child attributes
Identity provider identifier. At least one of identity_provider_id or user_store_id must be provided.
Pattern:
^con_[A-Za-z0-9]{16}$The user store to route the invitation through. At least one of identity_provider_id or user_store_id must be provided.
Pattern:
^con_[A-Za-z0-9]{16}$Number of seconds for which the invitation is valid before expiration. If unspecified or set to 0, this value defaults to 604800 seconds (7 days). Max value: 2592000 seconds (30 days).
Required range:
0 <= x <= 2592000Response
Create Member Invitations for an Organization.
The id of the member invitation
Pattern:
^uinv_[A-Za-z0-9]{16}$Organization identifier.
Pattern:
^org_[A-Za-z0-9]{16}$Show child attributes
Show child attributes
Show child attributes
Show child attributes
Identity provider identifier.
Pattern:
^con_[A-Za-z0-9]{16}$Identity provider identifier.
Pattern:
^con_[A-Za-z0-9]{16}$The ISO 8601 formatted timestamp representing the creation time of the invitation.
The ISO 8601 formatted timestamp representing the expiration time of the invitation.
The ID of a role that can be assigned to a member of an organization.
Pattern:
^rol_(?:[A-Za-z0-9]{16}|sys_[a-z0-9_]{1,64})$The invitation url to be sent to the invitee.
The ID of the invitation ticket.