The identifier of the flow.
POST
/admin/v1/flows/{flowId}:cancelCancel a flow
Cancels specified flow.
Returns
The target organization for the flow.
The connected accounts.
The tenant connection.
The delegated connection.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]
).The reply to email address.
The email address (e.g.
[email protected]
).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The organization's default active subscription.
The plan.
The target user for the flow.
The connected accounts.
The tenant connection.
The delegated connection.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]
).The reply to email address.
The email address (e.g.
[email protected]
).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The user's default active individual subscription.
See memberships for organization subscription and seat information.
The plan.
The user's organization memberships.
The organization.
The connected accounts.
The tenant connection.
The delegated connection.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]
).The reply to email address.
The email address (e.g.
[email protected]
).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The organization's default active subscription.
The plan.
The user's role within the organization.
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.
The user who created the flow.
This will not be set if the invitation was created by an admin.
The connected accounts.
The tenant connection.
The delegated connection.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]
).The reply to email address.
The email address (e.g.
[email protected]
).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The user's default active individual subscription.
See memberships for organization subscription and seat information.
The plan.
The user's organization memberships.
The organization.
The connected accounts.
The tenant connection.
The delegated connection.
The Google Cloud Identity Platform (Firebase Auth) connection.
The Postmark configuration data.
The from email address.
The Postmark account must be allowed to send from this email address.
The email address (e.g.
[email protected]
).The reply to email address.
The email address (e.g.
[email protected]
).The webhooks configuration data.
The payment methods for connections that support it.
The last payment error.
This will be unset if the payment method is updated or if a payment succeeds.
Card payment method (e.g. Visa credit card).
The organization's default active subscription.
The plan.
The user's role within the organization.
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.
The join organization flow type specific data.
The role to be assigned to the invitee.
curl https://api.userhub.com/admin/v1/flows/flow_3on5rHNG5aMGao:cancel \
-H "Authorization: Bearer $ADMIN_API_KEY" \
-X POST
const res = await adminApi.flows.cancel(
"flow_3on5rHNG5aMGao",
);
res, err := adminApi.Flows().Cancel(
context.Background(),
"flow_3on5rHNG5aMGao",
nil,
)
$res = $adminApi->flows->cancel(
flowId: 'flow_3on5rHNG5aMGao',
);
res = admin_api.flows.cancel(
flow_id="flow_3on5rHNG5aMGao",
)
{
"id": "flow_3on5rHNG5aMGao",
"state": "CANCELED",
"type": "JOIN_ORGANIZATION",
"organization": {
"id": "org_28seyVGVL1got6",
"state": "ACTIVE",
"displayName": "Acme Inc",
"email": "[email protected]",
"emailVerified": true,
"imageUrl": "https://example.com/acme.jpg",
"address": null,
"accountConnections": [],
"subscription": null,
"signupTime": "2024-06-15T13:00:00Z",
"memberCount": 0,
"createTime": "2024-06-15T13:00:00Z",
"updateTime": "2024-06-15T13:00:00Z"
},
"user": {
"id": "usr_MKFxzgJaAH8JQ4",
"state": "ACTIVE",
"displayName": "Jane Doe",
"email": "[email protected]",
"emailVerified": true,
"phoneNumber": "+12125550123",
"phoneNumberVerified": false,
"imageUrl": "https://example.com/jane.jpg",
"currencyCode": "USD",
"languageCode": "en",
"regionCode": "US",
"timeZone": "America/New_York",
"address": {
"lines": [
"42 West St"
],
"city": "Brooklyn",
"state": "New York",
"postalCode": "11222",
"country": "US"
},
"accountConnections": [],
"subscription": null,
"memberships": [],
"signupTime": "2024-06-15T13:00:00Z",
"createTime": "2024-06-15T13:00:00Z",
"updateTime": "2024-06-15T13:00:00Z"
},
"creator": {
"id": "usr_EHTXpuz9rs8TCU",
"state": "ACTIVE",
"displayName": "John Doe",
"email": "[email protected]",
"emailVerified": false,
"phoneNumber": "+12345678901",
"phoneNumberVerified": false,
"imageUrl": "https://example.com/john.jpg",
"address": null,
"accountConnections": [],
"subscription": null,
"memberships": [],
"signupTime": "2024-06-15T13:00:00Z",
"createTime": "2024-06-15T13:00:00Z",
"updateTime": "2024-06-15T13:00:00Z"
},
"startTime": null,
"expireTime": "2024-06-15T13:00:00Z",
"createTime": "2024-06-15T13:00:00Z",
"updateTime": "2024-06-15T13:00:00Z",
"joinOrganization": {
"email": "[email protected]",
"role": null
}
}