Some invitation use cases need a way of passing/persisting additional context metadata within the invite, such as additional properties about the user-to-be-invited.
The model currently supports a roles[] array; but could benefit a free-form key-value Map<String, String> attributes map (much like many of the other Keycloak models), so that additional context can be passed to the consumer.
In scope:
Add an invitation attributes table to the migrations
Add attributes to the model and representation
Add a new method GET /:realm/orgs/:orgId/invitations/:inviteId to get invitations by id
Make the attributes map available on the FTL context for the invitation email
Out of scope:
Transferring those attributes after the invitation is accepted/denied
Building Admin UI or Admin Portal UI to allow setting and/or viewing the attributes (maybe in the future)
Some invitation use cases need a way of passing/persisting additional context metadata within the invite, such as additional properties about the user-to-be-invited. The model currently supports a
roles[]
array; but could benefit a free-form key-valueMap<String, String>
attributes map (much like many of the other Keycloak models), so that additional context can be passed to the consumer.In scope:
GET /:realm/orgs/:orgId/invitations/:inviteId
to get invitations by idOut of scope: