The Flow object

An invitation, task, or user request (e.g. join organization).

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.
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.
imageUrl
string
The photo/avatar URL of 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.
user
User
The target user for the flow.
id
string
The system-assigned identifier of the user.
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.
imageUrl
string
The photo/avatar URL of the user.
disabled
boolean
Whether the user is disabled.
creator
User
The user who created the flow.
id
string
The system-assigned identifier of the user.
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.
imageUrl
string
The photo/avatar URL of the user.
disabled
boolean
Whether the user is disabled.
expireTime
date-time
The time the flow will expire.
createTime
date-time
The creation 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.
This is required if a user isn't provided or the user's email address is empty.
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.
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.

PreviousFlows

NextList flows