User setup created

Type: object
Domain: audit
Event: user_setup_create
Version: 1

method required

Title: The operation HTTP method
Type: string
Example:
POST

uri required

Title: The API operation URI
Type: string
Example:
/v1/users/setup

email required

Title: The operator email
Type: string
Example:
[email protected]

roles required

Title: The operator roles
Type: array
Example:

[
    "backoffice-operator",
    "crm-operator",
    "geroficios-operator",
    "inspetoria-master",
    "inspetoria-operator",
    "itibackoffice-master",
    "itibackoffice-operator",
    "itinivel1-operator",
    "treasury-operator"
]

origin required

Title: The Origin Schema
Type: string
Example:
CRM
APP

object required

Title: The audit data message
Type: object

email required

Title: The user email
Type: string
Example:
[email protected]

name required

Title: The user name
Type: string
Example:
UserName
roles required
Title: The user roles
Type: array
Example:
[
    "crm-operator"
]

{
    "$id": "http://example.com/root.json",
    "type": "object",
    "title": "User setup created",
    "required": [
        "method",
        "uri",
        "email",
        "roles",
        "origin",
        "object"
    ],
    "properties": {
        "method": {
            "type": "string",
            "title": "The operation HTTP method",
            "examples": [
                "POST"
            ]
        },
        "uri": {
            "type": "string",
            "title": "The API operation URI",
            "examples": [
                "/v1/users/setup"
            ]
        },
        "email": {
            "type": "string",
            "title": "The operator email",
            "default": null,
            "examples": [
                "[email protected]"
            ]
        },
        "roles": {
            "type": "array",
            "title": "The operator roles",
            "items": {
                "type": "string",
                "title": "The roles",
                "default": null,
                "examples": [
                    "backoffice-operator",
                    "crm-operator",
                    "geroficios-operator",
                    "inspetoria-master",
                    "inspetoria-operator",
                    "itibackoffice-master",
                    "itibackoffice-operator",
                    "itinivel1-operator",
                    "treasury-operator"
                ]
            }
        },
        "origin": {
            "type": "string",
            "title": "The Origin Schema",
            "default": "APP",
            "examples": [
                "CRM",
                "APP"
            ]
        },
        "object": {
            "type": "object",
            "title": "The audit data message",
            "required": [
                "email",
                "name",
                "roles"
            ],
            "properties": {
                "email": {
                    "type": "string",
                    "title": "The user email ",
                    "examples": [
                        "[email protected]"
                    ]
                },
                "name": {
                    "type": "string",
                    "title": "The user name",
                    "examples": [
                        "UserName"
                    ]
                },
                "roles": {
                    "type": "array",
                    "title": "The user roles",
                    "items": {
                        "type": "string",
                        "title": "The roles",
                        "default": "",
                        "examples": [
                            "crm-operator"
                        ]
                    }
                }
            }
        }
    }
}

{
    "method": "POST",
    "uri": "/v1/users/setup",
    "email": "[email protected]",
    "roles": [
        "backoffice-operator",
        "crm-operator",
        "geroficios-operator",
        "inspetoria-master",
        "inspetoria-operator",
        "itibackoffice-master",
        "itibackoffice-operator",
        "itinivel1-operator",
        "treasury-operator"
    ],
    "origin": "CRM",
    "object": {
        "email": "[email protected]",
        "name": "UserName",
        "roles": [
            "crm-operator"
        ]
    }
}

Updated 15 days ago