AuthN | Python SDK | Invite Endpoints

Invite Endpoints

Invite User

authn.user.invite(inviter, email, callback, state)

Send an invitation to a user.

required parameters

inviter

str

An email address

email

str

An email address

callback

str

A login callback URI

state

str

State tracking string for login callbacks

Response Object

A PangeaResponse with a pending user invitation in the response.result field. Available response fields can be found in our API Documentation.

response = authn.user.invite(
    inviter="admin@email.com",
    email="joe.user@email.com",
    callback="/callback",
    state="pcb_zurr3lkcwdp5keq73htsfpcii5k4zgm7"
)

Delete Invite

authn.user.invites.delete(id)

Delete a user invitation.

required parameters

id

str

A one-time ticket

Response Object

A PangeaResponse with an empty object in the response.result field.

authn.user.invites.delete(
    id="pmc_wuk7tvtpswyjtlsx52b7yyi2l7zotv4a",
)

List Invites

authn.user.invites.list(filter, last, order, order_by, size)

Look up active invites for the userpool.

optional parameters

filter

dict

last

str

Reflected value from a previous response to obtain the next page of results.

order

m.ItemOrder

Order results asc(ending) or desc(ending).

order_by

m.UserInviterOrderBy

Which field to order results by.

size

int

Maximum results to include in the response. Minimum: 1.

Response Object

A PangeaResponse with a list of pending user invitations in the response.result field. Available response fields can be found in our API Documentation.

response = authn.user.invites.list()