POST/admin/v1/flows:createSignup

Send a signup invitation

Create a signup flow. This invites a person to join the app.

body parameters

email
string
Required
The email address of the person to invite.
displayName
string
The display name of the person to invite.
createOrganization
boolean
Whether to create an organization as part of the signup flow.
creatorUserId
string
The identifier of the user sending the invite.
expireTime
date-time
The time the flow will expire.
This field is not allowed if ttl is specified.
ttl
string
The amount of time a flow will be available (e.g. 86400s).
This must be a string with the number of seconds followed by a trailing s.
This field is not allowed if expireTime is specified.

Returns

id
string
The system-assigned identifier of the flow.
state
enum
The current state of the flow.
Possible values:
START_PENDINGSTARTEDCOMPLETEDCANCELEDEXPIRED
stateReason
string
The code that best describes the reason for the state.
type
enum
The flow type.
Possible values:
JOIN_ORGANIZATIONSIGNUP
organization
Organization
The target organization for the flow.
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The connection type.
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
type
string
The provider type.
default
boolean
Whether the connection is the default for the provider type.
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
allowedEmails
string[]
The allowed email list.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
allowedEmails
string[]
The allowed email list.
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
currencyCode
string
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The payment method type.
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
pullTime
date-time
The last time the payment method was pulled from the connection.
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
pullTime
date-time
The last time the account was pulled from the connection.
pushTime
date-time
The last time the account was pushed to the connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The organization's default active subscription.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
ACTIVETRIALINGPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
signupTime
date-time
The sign-up time for the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
createTime
date-time
The creation time of the organization.
updateTime
date-time
The last update time of the organization.
user
User
The target user for the flow.
id
string
The system-assigned identifier of the user.
state
enum
The current state of the user.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
phoneNumber
string
The E164 phone number for the user (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the user's phone number has been verified.
imageUrl
string
The photo/avatar URL of the user.
currencyCode
string
The default ISO-4217 currency code for the user (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the user (e.g. en).
regionCode
string
The country/region code for the user (e.g. US).
timeZone
string
The IANA time zone for the user (e.g. America/New_York).
address
Address
The billing address for the user.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The connection type.
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
type
string
The provider type.
default
boolean
Whether the connection is the default for the provider type.
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
allowedEmails
string[]
The allowed email list.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
allowedEmails
string[]
The allowed email list.
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
currencyCode
string
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The payment method type.
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
pullTime
date-time
The last time the payment method was pulled from the connection.
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
pullTime
date-time
The last time the account was pulled from the connection.
pushTime
date-time
The last time the account was pushed to the connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The user's default active individual subscription.
See memberships for organization subscription and seat information.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
ACTIVETRIALINGPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
memberships
Membership[]
The user's organization memberships.
organization
Organization
The organization.
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The connection type.
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
type
string
The provider type.
default
boolean
Whether the connection is the default for the provider type.
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
allowedEmails
string[]
The allowed email list.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
allowedEmails
string[]
The allowed email list.
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
currencyCode
string
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The payment method type.
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
pullTime
date-time
The last time the payment method was pulled from the connection.
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
pullTime
date-time
The last time the account was pulled from the connection.
pushTime
date-time
The last time the account was pushed to the connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The organization's default active subscription.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
ACTIVETRIALINGPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
signupTime
date-time
The sign-up time for the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
createTime
date-time
The creation time of the organization.
updateTime
date-time
The last update time of the organization.
role
Role
The user's role within the organization.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
archived
boolean
The archived status of the role.
createTime
date-time
The creation time of the role.
updateTime
date-time
The last update time of the role.
seat
AccountSubscriptionSeat
The seat associated with the membership.
This will be absent if there is no active default subscription for the organization or the user has not been assigned a seat.
product
AccountSubscriptionProduct
The seat product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
createTime
date-time
The creation time of the membership.
updateTime
date-time
The last update time of the membership.
signupTime
date-time
The sign-up time for the user.
disabled
boolean
Whether the user is disabled.
createTime
date-time
The creation time of the user.
updateTime
date-time
The last update time of the user.
creator
User
The user who created the flow.
This will not be set if the invitation was created by an admin.
id
string
The system-assigned identifier of the user.
state
enum
The current state of the user.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the user account.
displayName
string
The human-readable display name of the user.
email
string
The email address of the user.
emailVerified
boolean
Whether the user's email address has been verified.
phoneNumber
string
The E164 phone number for the user (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the user's phone number has been verified.
imageUrl
string
The photo/avatar URL of the user.
currencyCode
string
The default ISO-4217 currency code for the user (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the user (e.g. en).
regionCode
string
The country/region code for the user (e.g. US).
timeZone
string
The IANA time zone for the user (e.g. America/New_York).
address
Address
The billing address for the user.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The connection type.
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
type
string
The provider type.
default
boolean
Whether the connection is the default for the provider type.
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
allowedEmails
string[]
The allowed email list.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
allowedEmails
string[]
The allowed email list.
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
currencyCode
string
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The payment method type.
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
pullTime
date-time
The last time the payment method was pulled from the connection.
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
pullTime
date-time
The last time the account was pulled from the connection.
pushTime
date-time
The last time the account was pushed to the connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The user's default active individual subscription.
See memberships for organization subscription and seat information.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
ACTIVETRIALINGPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
memberships
Membership[]
The user's organization memberships.
organization
Organization
The organization.
id
string
The system-assigned identifier of the organization.
state
enum
The current state of the organization.
Possible values:
ACTIVEDISABLEDARCHIVEDPENDING_DELETION
stateReason
string
The code that best describes the reason for the state.
uniqueId
string
The client defined unique identifier of the organization account.
displayName
string
The human-readable display name of the organization.
email
string
The email address of the organization.
emailVerified
boolean
Whether the organization's email address has been verified.
phoneNumber
string
The E164 phone number for the organization (e.g. +12125550123).
phoneNumberVerified
boolean
Whether the organization's phone number has been verified.
imageUrl
string
The photo/avatar URL of the organization.
currencyCode
string
The default ISO-4217 currency code for the organization (e.g. USD).
languageCode
string
The IETF BCP-47 language code for the organization (e.g. en).
regionCode
string
The country/region code for the organization (e.g. US).
timeZone
string
The IANA time zone for the organization (e.g. America/New_York).
address
Address
The address for the organization.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
accountConnections
AccountConnection[]
The connected accounts.
connection
Connection
The tenant connection.
id
string
The system-assigned identifier of the connection.
uniqueId
string
The client defined unique identifier of the connection.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with conn_ are reserved.
displayName
string
The human-readable display name of the connection.
The maximum length is 200 characters.
state
enum
The current status of the connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The connection type.
delegate
ConnectionDelegate
The delegated connection.
id
string
The delegated connection identifier.
uniqueId
string
The client defined unique identifier of the delegated connection.
displayName
string
The human-readable display name of the delegated connection.
state
enum
The current status of the delegated connection.
Possible values:
PENDING_SETUPACTIVEBROKENDISABLEDARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The delegated connection type.
providers
ConnectionProvider[]
The connection providers.
type
string
The provider type.
default
boolean
Whether the connection is the default for the provider type.
createTime
date-time
The creation time of the connection.
updateTime
date-time
The last update time of the connection.
auth0
Auth0Connection
The Auth0 connection data.
domain
string
The Auth0 domain.
clientId
string
The Auth0 client ID.
clientSecret
string
The Auth0 client secret.
builtinEmail
BuiltinEmailConnection
The builtin email configuration data.
allowedEmails
string[]
The allowed email list.
googleCloudIdentityPlatform
GoogleCloudIdentityPlatformConnection
The Google Cloud Identity Platform (Firebase Auth) connection.
credentials
string
The service account key in JSON format.
projectId
string
The Google Cloud Identity Platform/Firebase project ID.
This will default to the project ID in the service account key if not specified.
postmark
PostmarkConnection
The Postmark configuration data.
serverToken
string
The Postmark server token (e.g. 942faf79-bf10-4dc1-830a-dc7943f43f35).
serverId
string
The Postmark server ID.
This is automatically populated when the server token is updated.
from
Email
The from email address.
The Postmark account must be allowed to send from this email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
replyTo
Email
The reply to email address.
address
string
The email address (e.g. [email protected]).
displayName
string
The email name (e.g. Jane Doe).
allowedEmails
string[]
The allowed email list.
stripe
StripeConnection
The Stripe billing configuration data.
accountId
string
The Stripe account ID (e.g. acct_1LcUvxQYGbxD2SPK)
live
boolean
The live vs test status for the Stripe account.
webhook
WebhookConnection
The webhooks configuration data.
url
string
The URL of the events webhook.
headers
string
The headers sent with requests to the connection URL.
signingSecrets
SigningSecret[]
The webhook secrets
secret
string
The signing secret value.
expireTime
date-time
The time the signing secret is set to expire.
externalId
string
The external identifier of the connected account.
adminUrl
string
The external admin URL for the connected account.
state
enum
The status of the connected account.
Possible values:
ACTIVEBROKENDISABLED
stateReason
string
The code that best describes the reason for the state.
balanceAmount
string
The balance amount for the account.
A negative value indicates an amount which will be subtracted from the next invoice (credit).
A positive value indicates an amount which will be added to the next invoice (debt).
currencyCode
string
The currency code for the account.
paymentMethods
PaymentMethod[]
The payment methods for connections that support it.
id
string
The system-assigned identifier of the payment method.
externalId
string
The external identifier of the connected payment method.
state
enum
The status of the connected payment method.
Possible values:
ACTIVEBROKENARCHIVED
stateReason
string
The code that best describes the reason for the state.
type
string
The payment method type.
displayName
string
A human-readable description of the payment method.
This can be used to show a description of the payment method when the type is UNKNOWN or not explicitly handled.
fullName
string
The full name of the owner of the payment method.
address
Address
The address for the payment method.
lines
string[]
The address lines.
city
string
The city, district, suburb, town, or village.
state
string
The state, country, province, or region.
postalCode
string
The ZIP or postal code.
country
string
The 2-letter country code.
default
boolean
Whether the payment method is the default for the connected account.
lastPaymentError
Status
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.
pullTime
date-time
The last time the payment method was pulled from the connection.
createTime
date-time
The creation time of the payment method connection.
updateTime
date-time
The last update time of the payment method connection.
card
CardPaymentMethod
Card payment method (e.g. Visa credit card).
brand
enum
The brand of the card (e.g. VISA).
Possible values:
AMERICAN_EXPRESSDINERS_CLUBDISCOVERJCBMASTERCARDUNIONPAYVISA
last4
string
The last for digits of the card.
fundingType
enum
The funding method for the card (e.g. DEBIT).
Possible values:
CREDITDEBITPREPAID
expYear
int32
The expiration year.
expMonth
int32
The expiration month.
pullTime
date-time
The last time the account was pulled from the connection.
pushTime
date-time
The last time the account was pushed to the connection.
createTime
date-time
The creation time of the account connection.
updateTime
date-time
The last update time of the account connection.
subscription
AccountSubscription
The organization's default active subscription.
id
string
The system-assigned identifier of the subscription.
state
enum
The state of the subscription.
Possible values:
ACTIVETRIALINGPAST_DUEPAUSED
anchorTime
date-time
The anchor time of the billing cycle.
plan
AccountSubscriptionPlan
The plan.
id
string
The identifier of the plan.
displayName
string
The human-readable display name of the plan.
product
AccountSubscriptionProduct
The plan product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
signupTime
date-time
The sign-up time for the organization.
memberCount
int32
The number of members in the organization.
This includes disabled users, but does not include user's marked for deletion.
disabled
boolean
Whether the organization is disabled.
createTime
date-time
The creation time of the organization.
updateTime
date-time
The last update time of the organization.
role
Role
The user's role within the organization.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
archived
boolean
The archived status of the role.
createTime
date-time
The creation time of the role.
updateTime
date-time
The last update time of the role.
seat
AccountSubscriptionSeat
The seat associated with the membership.
This will be absent if there is no active default subscription for the organization or the user has not been assigned a seat.
product
AccountSubscriptionProduct
The seat product.
id
string
The system-assigned identifier of the product.
uniqueId
string
The client defined unique identifier of the product.
displayName
string
The human-readable display name of the product.
createTime
date-time
The creation time of the membership.
updateTime
date-time
The last update time of the membership.
signupTime
date-time
The sign-up time for the user.
disabled
boolean
Whether the user is disabled.
createTime
date-time
The creation time of the user.
updateTime
date-time
The last update time of the user.
startTime
date-time
The start time of the flow.
expireTime
date-time
The time the flow will expire.
ttl
string
The expire duration of the flow.
secret
string
The flow secret.
This is only populated on create.
createTime
date-time
The creation time of the flow.
updateTime
date-time
The last update time of the flow.
joinOrganization
JoinOrganizationFlow
The join organization flow type specific data.
displayName
string
The display name of the invitee.
email
string
The email address of the invitee.
role
Role
The role to be assigned to the invitee.
id
string
The system-assigned identifier of the role.
uniqueId
string
The client defined unique identifier of the role.
It is restricted to letters, numbers, underscores, and hyphens, with the first character a letter or a number, and a 255 character maximum.
ID's starting with role_ are reserved.
displayName
string
The human-readable display name of the role.
type
enum
The role type.
Possible values:
OWNERMEMBERGUEST
description
string
The description of the role.
The maximum length is 1000 characters.
permissionSets
string[]
The additional permissions allowed by the role.
default
boolean
Whether the role is the default for the tenant.
archived
boolean
The archived status of the role.
createTime
date-time
The creation time of the role.
updateTime
date-time
The last update time of the role.
signup
SignupFlow
The signup flow type specific data
email
string
The email address of the invitee.
displayName
string
The display name of the invitee.
createOrganization
boolean
Whether to create an organization as part of the signup flow.

code
enum
The general error code (e.g. INVALID_ARGUMENT).
Possible values:
OKCANCELLEDUNKNOWNINVALID_ARGUMENTDEADLINE_EXCEEDEDNOT_FOUNDALREADY_EXISTSPERMISSION_DENIEDUNAUTHENTICATEDRESOURCE_EXHAUSTEDFAILED_PRECONDITIONABORTEDOUT_OF_RANGEUNIMPLEMENTEDINTERNALUNAVAILABLEDATA_LOSS
message
string
A developer-facing error message.
reason
string
A reason code for the error (e.g. USER_PENDING_DELETION).
param
string
The parameter path related to the error (e.g. member.userId).
metadata
string
Additional metadata related to the error.

curl https://api.userhub.com/admin/v1/flows:createSignup \
  -H "Authorization: Bearer $ADMIN_API_KEY" \
  --json '{
    "email": "[email protected]"
  }'

const res = await adminApi.flows.createSignup({
  email: "[email protected]",
});

res, err := adminApi.Flows().CreateSignup(
    context.Background(),
    &adminapi.FlowCreateSignupInput{
        Email: "[email protected]",
    },
)

$res = $adminApi->flows->createSignup(
    email: '[email protected]',
);

res = admin_api.flows.createSignup(
    email="[email protected]",
)

Response bodyJSON

{
  "id": "flow_2VSCZXUfZVeRY3",
  "state": "START_PENDING",
  "type": "SIGNUP",
  "organization": null,
  "user": null,
  "creator": null,
  "startTime": null,
  "expireTime": "2024-07-15T13:00:00Z",
  "secret": "3fnpb3kr3q4ymtmD5Hnmh19GuD1uDzXdZeRZ3R",
  "createTime": "2024-06-15T13:00:00Z",
  "updateTime": "2024-06-15T13:00:00Z",
  "signup": {
    "email": "[email protected]"
  }
}

PreviousSend a join organization invitation

NextGet a flow

Send a signup invitation

.css-10iahqc{text-transform:capitalize;}body parameters

Returns

body parameters