json icon

Grant Application Access

v1.0.0commands

Asks CNA Auth to give a person access to an application, provisioning the account and user when they are new. Published by cna-one when an invited user is mirrored into a person; handled by cna-auth.

1{
2  "$schema": "https://json-schema.org/draft/2020-12/schema",
3  "title": "GrantApplicationAccess payload",
4  "type": "object",
5  "additionalProperties": false,
6  "properties": {
7    "id": {
8      "type": "string",
9      "description": "Id of the person in the publishing application (cna-one Person.id). Stored on the account as its person id."
10    },
11    "name": {
12      "type": "string",
13      "description": "Full name of the person (name and surname joined)."
14    },
15    "email": {
16      "type": "string",
17      "description": "E-mail the login is provisioned on. Taken from the invite, not from what the publisher stores."
18    },
19    "document": {
20      "type": "string",
21      "description": "Person document (CPF). Kafka message key and the field both systems correlate the person by."
22    },
23    "employeeId": {
24      "type": "string",
25      "description": "CNA One employee id the access is keyed by. Stored on the account."
26    },
27    "application": {
28      "type": "string",
29      "description": "Identifier of the application in cna-auth (applications.identifier), e.g. cna-one."
30    },
31    "origin": {
32      "type": "string",
33      "description": "System requesting the access: ONE, NEXUS or PLACEMENT. Must be one of the application's allowed origins; compared uppercase."
34    }
35  },
36  "required": [
37    "id",
38    "name",
39    "email",
40    "document",
41    "employeeId",
42    "application",
43    "origin"
44  ]
45}
46

Details

Format
JSON Schema
Resource
commands
Filename
schema.json

Versions