json icon

Invite User

v1.0.0commands

Invites a person into the CNA platform. Published by cna-nexus and cna-placement when a user is created or re-invited; handled by cna-one, which creates the person and employee and then requests application access from cna-auth.

1{
2  "$schema": "https://json-schema.org/draft/2020-12/schema",
3  "title": "InviteUser payload",
4  "type": "object",
5  "additionalProperties": false,
6  "properties": {
7    "email": {
8      "type": "string",
9      "description": "E-mail the person is invited on. Becomes the employee e-mail in cna-one and the login e-mail the access grant is provisioned on."
10    },
11    "name": {
12      "type": "string",
13      "description": "Full name. cna-one splits it into name (first word) and surname (the rest)."
14    },
15    "application": {
16      "type": "string",
17      "description": "Identifier of the application the person is invited to, as registered in cna-auth (applications.identifier). cna-nexus always sends cna-nexus."
18    },
19    "document": {
20      "type": "string",
21      "description": "Person document (CPF), 11 digits without mask. Kafka message key and the field cna-one correlates the person by."
22    }
23  },
24  "required": ["email", "name", "application", "document"]
25}
26

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions