Approve a flow

POST/user/v1/flows/{flowId}:approve

Approve a flow. This will approve the specified flow and start the next step in the flow (e.g. for a join organization flow it will send the invitee an email with a link to join the organization).

path parameters

flowId
string
Required
The identifier of the flow.

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.
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.
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.
expireTime
date-time
The time the flow will expire.
createTime
date-time
The creation time of the 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.
localeMessage
string
A user-facing error message.

curl https://api.userhub.com/user/v1/flows/flow_3on5rHNG5aMGao:approve \
  -H "UserHub-Api-Key: $USERHUB_USER_KEY" \
  -H "Authorization: Bearer $USER_ACCESS_TOKEN" \
  -X POST

const res = await userApi.flows.approve(
  "flow_3on5rHNG5aMGao",
);

res, err := userApi.Flows().Approve(
    context.Background(),
    "flow_3on5rHNG5aMGao",
    nil,
)

$res = $userApi->flows->approve(
    flowId: 'flow_3on5rHNG5aMGao',
);

res = user_api.flows.approve(
    flow_id="flow_3on5rHNG5aMGao",
)

Response bodyJSON

{
  "id": "flow_3on5rHNG5aMGao",
  "state": "START_PENDING",
  "type": "JOIN_ORGANIZATION",
  "organization": {
    "id": "org_28seyVGVL1got6",
    "displayName": "Acme Inc",
    "email": "[email protected]",
    "emailVerified": true,
    "imageUrl": "https://example.com/acme.jpg",
    "memberCount": 0
  },
  "user": {
    "id": "usr_MKFxzgJaAH8JQ4",
    "displayName": "Jane Doe",
    "email": "[email protected]",
    "emailVerified": true,
    "imageUrl": "https://example.com/jane.jpg"
  },
  "creator": {
    "id": "usr_EHTXpuz9rs8TCU",
    "displayName": "John Doe",
    "email": "[email protected]",
    "emailVerified": false,
    "imageUrl": "https://example.com/john.jpg"
  },
  "joinOrganization": {
    "email": "[email protected]",
    "role": null
  },
  "expireTime": "2024-11-15T13:00:00Z",
  "createTime": "2024-11-15T13:00:00Z"
}

PreviousGet a flow

NextConsume a flow

Approve a flow

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

Returns

path parameters