Files
iam/internal/invitations/zipdoc_gen.go
zooqueenandHanzo Dev 7dc0df21aa Join codes share the mailbox ledger, IAM mints invitation codes, and only the seed marks platform apps
A join code is claimed in the per-mailbox ledger (3 per inviting org, 20 across orgs a day) under the joining org's lock before it is sent, under a fixed subject. POST /v1/iam/invitations mints a 20-character crypto/rand code when none is given and marks it generated; only generated codes skip the per-org gate, so a typed code however strong it looks stays behind it. Names keep combining marks and an inviter without a display name is left out; an address with an empty domain label is not bare. The platform flag is written by the seed alone, on a locked fresh read.

Co-authored-by: Hanzo Dev <[email protected]>
2026-09-27 09:37:43 -07:00

49 lines
4.7 KiB
Go

// Code generated by zipdoc; DO NOT EDIT.
package invitations
import (
"github.com/zap-proto/zip"
)
func init() {
zip.Describe("github.com/hanzoai/iam/internal/invitations DELETE /v1/iam/invitations/:owner/:name", zip.Doc{
Description: "Withdraws an invitation. It stops being redeemable at once; anyone who\nalready joined through it keeps their account.",
})
zip.Describe("github.com/hanzoai/iam/internal/invitations GET /v1/iam/invitations", zip.Doc{
Description: "Returns your organization's invitations, newest first — who has\nbeen asked to join, on what terms, and how many seats each invitation still\nhas left.\n\nYou see the invitations of the organization your credentials run, and no one\nelse's: your own, or one you own or administer.",
Fields: map[string]string{
"Invitation.generated": "Generated reports that IAM minted Code itself, from crypto/rand, when the\ninvitation was created. Only such a code is compared without limit; any code\na caller wrote is compared only while the org is not being guessed at, however\nit looks, because a code that looks random need not be.",
"Invitation.sentTime": "SentTime is when an email about this invitation last went to its pinned\naddress (RFC 3339), \"\" when none has. It paces resends, so the send\nendpoint cannot be used to mail one address over and over.",
"Model[github.com/hanzoai/iam/pkg/schema.Invitation].id": "Persisted fields",
},
})
zip.Describe("github.com/hanzoai/iam/internal/invitations GET /v1/iam/invitations/:owner/:name", zip.Doc{
Description: "Returns one invitation: who it is for, what it grants on acceptance, and\nwhen it expires.",
Fields: map[string]string{
"Invitation.generated": "Generated reports that IAM minted Code itself, from crypto/rand, when the\ninvitation was created. Only such a code is compared without limit; any code\na caller wrote is compared only while the org is not being guessed at, however\nit looks, because a code that looks random need not be.",
"Invitation.sentTime": "SentTime is when an email about this invitation last went to its pinned\naddress (RFC 3339), \"\" when none has. It paces resends, so the send\nendpoint cannot be used to mail one address over and over.",
"Model[github.com/hanzoai/iam/pkg/schema.Invitation].id": "Persisted fields",
},
})
zip.Describe("github.com/hanzoai/iam/internal/invitations POST /v1/iam/invitations", zip.Doc{
Description: "Issues an invitation to join your organization — the code or link a new\nmember redeems, with the role they arrive holding and the date it stops\nworking. A name already used in the organization is refused.",
Fields: map[string]string{
"Invitation.generated": "Generated reports that IAM minted Code itself, from crypto/rand, when the\ninvitation was created. Only such a code is compared without limit; any code\na caller wrote is compared only while the org is not being guessed at, however\nit looks, because a code that looks random need not be.",
"Invitation.sentTime": "SentTime is when an email about this invitation last went to its pinned\naddress (RFC 3339), \"\" when none has. It paces resends, so the send\nendpoint cannot be used to mail one address over and over.",
"Model[github.com/hanzoai/iam/pkg/schema.Invitation].id": "Persisted fields",
},
})
zip.Describe("github.com/hanzoai/iam/internal/invitations POST /v1/iam/invitations/:owner/:name/send", zip.Doc{
Description: "Emails an invitation to the address it is pinned to: who invited them, to\nwhich organization, and the link that joins them.\n\nThe caller chooses nothing about how it goes out. It is sent through the\nplatform application the caller's access token was issued to, from that\napplication's org's email account, with a link on the identity host that issued\nthe token — the way the inviter came in. Only the pinned address receives it.",
})
zip.Describe("github.com/hanzoai/iam/internal/invitations PUT /v1/iam/invitations/:owner/:name", zip.Doc{
Description: "Changes an invitation's terms — the role it grants, how many may redeem\nit, or when it expires. What it is called does not change.",
Fields: map[string]string{
"Invitation.generated": "Generated reports that IAM minted Code itself, from crypto/rand, when the\ninvitation was created. Only such a code is compared without limit; any code\na caller wrote is compared only while the org is not being guessed at, however\nit looks, because a code that looks random need not be.",
"Invitation.sentTime": "SentTime is when an email about this invitation last went to its pinned\naddress (RFC 3339), \"\" when none has. It paces resends, so the send\nendpoint cannot be used to mail one address over and over.",
"Model[github.com/hanzoai/iam/pkg/schema.Invitation].id": "Persisted fields",
},
})
}