Skip to content
Prefactor Docs

Revoke an admin user invite

POST
/api/v1/admin_user_invite/{admin_user_invite_id}/revoke

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
admin_user_invite_id
required
AdminUserInvite_Id

A valid admin user invite ID

string
Example
013xrzp12g3nqk8nwtt8vkzttc9fypm6

Request Body

Section titled “Request Body ”
One of:
IdempotencyKeyOrNull

Optional idempotency key for ensuring request idempotency

string

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Success

object
details
AdminUserInvite_Details
object
account_id
Account_Id

A valid account ID

string
Example
013xrzp12g3nqk8ngskn1wtxgka5b0nf
email

Email address the invite was sent to

string
Example
user@example.com
id
AdminUserInvite_Id

A valid admin user invite ID

string
Example
013xrzp12g3nqk8nwtt8vkzttc9fypm6
inserted_at

When the invite was created

string format: date-time
Example
2024-01-01T00:00:00Z
invite_url
Uri

URL to accept the invite

string format: uri
Example
https://example.com
status

Current status of the invite

string
Allowed values: pending used revoked
Example
pending
token

Unique token for the invite

string
Example
abc123def456...
type

Type of resource (always ‘admin_user_invite’)

string
Allowed values: admin_user_invite
Example
admin_user_invite
updated_at

When the invite was last updated

string format: date-time
Example
2024-01-01T00:00:00Z
status
string
Allowed values: success
Example
success

default

Section titled “default ”

Error

One of:
object
code
string
Allowed values: bad_request bad_authtoken not_authenticated not_permitted not_implemented unknown not_found unexpected_ref_type unexpected invalid_action invalid_value required_value idempotency_key_already_used
Example
bad_request
message
string
status
string
Allowed values: error
Example
error