Auth Groups

Sends an AuthGroup invite to the given email.

Generates and sends an invitation link for the given Site or View (AuthGroup) to the given user email.

post/api/authgroup/invite

Request

Base URL
https://passivelogic.com (the document declares no server; this is the origin it was published from)
Auth
- API key in header X-PL-AUTH
- or API key in header Authorization: PL-API-KEY
- or API key in header PL-API-KEY
- or HTTP basic
TypeScript
https://skmtc.dev/passivelogic/apis/passivelogic-http-api/docs/api/authgroup/invite/post.ts
A function with typed inputs. Its response is checked against the schema.

expirationstring date-time nullable

Timestamp at which this invitation will no longer be valid

authGroupIDstring uuid required

ID of the AuthGroup to which this invite pertains

inviteEmailstring required

Email to send the invite to

role'PrivilegedUser' | 'ReadOnlyUser' | 'StandardUser' | 'SuperUser'

messagestring required

Message with additional information

inviteIDstring uuid required

ID of the invitation generated/sent

No recorded changes to this operation across all 1 revision of this API.