• management
• Management
• CreateOrganizationInvitationRequestContent

Interface CreateOrganizationInvitationRequestContent

Example

{ * inviter: { * name: "name" * }, * invitee: { * email: "email" * }, * client_id: "client_id" * }Copy

interface CreateOrganizationInvitationRequestContent {
inviter: OrganizationInvitationInviter;
invitee: OrganizationInvitationInvitee;
client_id: string;
connection_id?: string;
app_metadata?: AppMetadata;
user_metadata?: UserMetadata;
ttl_sec?: number;
roles?: string[];
send_invitation_email?: boolean;
}

Index

Properties

inviterinviteeclient_idconnection_id?app_metadata?user_metadata?ttl_sec?roles?send_invitation_email?

Properties

inviter

inviter: OrganizationInvitationInviter

invitee

invitee: OrganizationInvitationInvitee

client_id

client_id: string

Auth0 client ID. Used to resolve the application's login initiation endpoint.

Optionalconnection_id

connection_id?: string

The id of the connection to force invitee to authenticate with.

Optionalapp_metadata

app_metadata?: AppMetadata

Optionaluser_metadata

user_metadata?: UserMetadata

Optionalttl_sec

ttl_sec?: number

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).

Optionalroles

roles?: string[]

List of roles IDs to associated with the user.

Optionalsend_invitation_email

send_invitation_email?: boolean

Whether the user will receive an invitation email (true) or no email (false), true by default

Settings

Member Visibility

• Protected
• Inherited

ThemeOSLightDark

On This Page

Properties inviterinviteeclient_idconnection_idapp_metadatauser_metadatattl_secrolessend_invitation_email