Summary
Create a new account for Local AAA instance.
Description
Create a new account for Local AAA instance in IAP.
Route
POST /user-management/accounts
Roles
Parameters
Name | Type | Required | Description |
---|---|---|---|
account | object | yes | An object containing all the account properties. |
{ "account": { "username": "admin@pronghorn", "password": "$2a$08$SLW8yGVhHUaXL5Hjgp30DOvYsY5Jx39AsiSzpUOn", "groups": [ "pronghorn_admin", "pronghorn_admin", "pronghorn_admin" ] } }
{ "type": "object", "properties": { "account": { "title": "account", "type": "object", "properties": { "username": { "type": "string", "examples": [ "admin@pronghorn" ] }, "password": { "type": "string", "examples": [ "$2a$08$SLW8yGVhHUaXL5Hjgp30DOvYsY5Jx39AsiSzpUOn" ] }, "groups": { "type": "array", "items": { "type": "string", "examples": [ "pronghorn_admin" ] } } }, "required": [ "username", "password" ] } }, "required": [ "account" ], "additionalProperties": false }
Return
Name | Type | Description |
---|---|---|
result | object | The result of the account creation process. |
{ "status": "OK", "message": "A sample success message", "data": { "applicationProps": { "directory": "/opt/pronghorn/current/node_modules", "description": "Application" }, "uiProps": { "layout": "node_modules/@itential/pronghorn-core/ui/views/layout.jade", "home": "node_modules/@itential/pronghorn-core/ui/views/home.jade", "login": "node_modules/@itential/pronghorn-core/ui/views/login.jade", "profile": "node_modules/@itential/pronghorn-core/ui/views/profile.jade", "fav_icon": "node_modules/@itential/pronghorn-core/ui/img/favicon.ico", "description": "UI" }, "authenticationProps": { "uniqueSession": false, "admins": [ { "provenance": "Local AAA", "group": "" } ], "description": "audit", "cookieName": "pronghorn_token" }, "expressProps": { "express_http": { "enable": false, "port": 11412 }, "express_https": { "enable": true, "port": 48948, "key": "/opt/pronghorn/current/keys/key.pem", "cert": "/opt/pronghorn/current/keys/cert.pem", "secureProtocol": "TLSv1_2_method", "client_reneg_limit": 1, "client_reneg_window": 600, "passphrase": "ut laborum culpa commodo dolor", "ciphers": "" }, "description": "Express Server", "cacheControl": false, "timeout": 300000, "access_control_allow_origin": "*" }, "loggerProps": { "log_directory": "/var/log/pronghorn", "log_filename": "pronghorn.log", "log_max_file_size": 1048576, "log_max_files": 100, "log_level": "debug", "console_level": "trace", "description": "Logging", "log_timezone_offset": -5, "webserver": { "log_directory": "/var/log/pronghorn", "log_filename": "webserver.log" }, "syslog": { "level": "warning", "facility": "local0", "type": "BSD", "host": "localhost", "port": 514, "protocol": "udp4", "pid": "process.pid", "localhost": "", "app_name": "process.title", "eol": "" } }, "redisProps": { "host": "localhost", "port": 6379, "db": 0, "password": "$ENC87eb897b507afc1796db49409dd1251c87872e85afd2469e", "maxRetriesPerRequest": 20, "maxHeartbeatWriteRetries": 20 }, "auditProps": { "audit": true, "brokerValidation": true, "description": "Audit" }, "pathProps": { "encrypted": true, "description": "Path Properties" }, "alarmProps": [ { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" }, { "ip": "127.0.0.1", "community": "public", "properties": { "retries": 1, "timeout": 5000, "trapPort": 162, "version": "V1", "transport": "udp4" }, "type": "trap", "description": "Alarm" } ], "id": "profile1", "services": [ "WorkflowBuilder", "WorkflowBuilder", "FormBuilder", "FormBuilder", "FormBuilder" ], "description": "An IAP Profile", "rabbitmq": { "protocol": "amqp", "hosts": "rabbitmq", "port": 41080, "username": "", "password": "guest", "locale": "en_US", "frameMax": 0, "heartbeat": 0, "vhost": "/", "eventDeduplication": { "active": false, "cacheTtl": 100, "cacheSize": 100, "cachePersistence": "memory", "messagePreservation": { "strategy": "automatic", "preserveMessages": true, "tempQueueName": "iap_event__TMP__", "shovelName": "preserve_iap_events", "shovelAckMode": "on-confirm", "shovelAddHeaders": false, "shovelPrefetchCount": 1000, "shovelReconnectDelay": 5, "maxTransferWait": 5, "transferWaitPollIncrement": 0.1 } }, "adminPort": 59195 }, "adapterStrategy": { "device": { "adapterTypes": [], "exceptions": { "runCommand": "" } } }, "systemProps": { "shutdownTimeout": 3, "servicesBlacklist": [ "Local AAA", "Local AAA" ], "launchDelay": 5, "launchTimeout": 60, "deadProcessCheck": false, "deadProcessCheckInterval": 5, "deadProcessMaxPeriod": 15 }, "prebuiltProps": { "repoConfigs": { "@itentialopensource": { "enabled": true, "type": "gitlab", "hostname": "gitlab.com", "path": "itentialopensource/pre-built-automations", "credentials": { "token": "uTc_P4pnMAEsLbQHmyOt" } } } }, "integrationProps": { "threadCount": 5, "timeout": 15000 }, "retryStrategy": { "maxRetries": 5, "retryResetTimer": 30000 } } }
{ "title": "result", "type": "object", "properties": { "status": { "$ref": "common-schema#/definitions/status" }, "message": { "$ref": "common-schema#/definitions/message" }, "data": { "$ref": "common-schema#/definitions/data" } } }