@itentialopensource/adapter-adtran_mosaic_cloud_platform

{ "id": "@itentialopensource/adapter-adtran_mosaic_cloud_platform", "type": "Adapter", "export": "AdtranMosaicCloudPlatform", "title": "Adtran_mosaic_cloud_platform", "src": "adapter.js", "roles": [ "admin" ], "methods": [ { "name": "iapUpdateAdapterConfiguration", "summary": "Updates the adapter configuration", "description": "Updates the adapter configuration file with the provided changes", "input": [ { "name": "configFile", "type": "string", "info": "The name of the file to change", "required": true, "schema": { "title": "configFile", "type": "string" } }, { "name": "changes", "type": "object", "info": "JSON object containing the configuration changes", "required": true, "schema": { "title": "changes", "type": "object" } }, { "name": "entity", "type": "string", "info": "The entity in which the changes are being made", "required": false, "schema": { "title": "entity", "type": "string" } }, { "name": "type", "type": "string", "info": "The type of file to change - action, schema, or mock", "required": false, "schema": { "title": "type", "type": "string" } }, { "name": "action", "type": "string", "info": "The action to be changed", "required": false, "schema": { "title": "action", "type": "string" } }, { "name" : "replace", "type": "boolean", "info": "True to replace entire mock data, false to merge/append", "required": false, "schema": { "title": "replace", "type" : "boolean" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUpdateAdapterConfiguration" }, "task": true }, { "name": "iapSuspendAdapter", "summary": "Suspends the adapter", "description": "Suspends the adapter", "input": [ { "name": "mode", "type": "enum", "enumerals": [ "pause", "error" ], "info": "How incoming requests are handled. Defaults to 'pause'", "description": "How incoming requests are handled. Defaults to 'pause'", "schema": { "title": "mode", "type": "string" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapSuspendAdapter" }, "task": true }, { "name": "iapUnsuspendAdapter", "summary": "Unsuspends the adapter", "description": "Unsuspends the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter suspended status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapUnsuspendAdapter" }, "task": true }, { "name": "iapGetAdapterQueue", "summary": "Return the requests that are waiting in the queue if throttling is enabled", "description": "Return the requests that are waiting in the queue if throttling is enabled", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the adapter queue", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetAdapterQueue" }, "task": true }, { "name": "iapFindAdapterPath", "summary": "Provides the ability to see if a particular API path is supported by the adapter", "description": "Provides the ability to see if a particular API path is supported by the adapter", "input": [ { "name": "apiPath", "type": "string", "info": "The API Path you want to check - make sure to not include base path and version", "description": "The API Path you want to check - make sure to not include base path and version", "schema": { "title": "apiPath", "type": "string" }, "required": true } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapFindAdapterPath" }, "task": true }, { "name": "iapTroubleshootAdapter", "summary": "Runs troubleshoot script for adapter", "description": "Runs troubleshoot script for adapter", "input": [ { "name": "props", "type": "object", "info": "Object containing configuration, healthcheck and auth properties {'connProps':{'host': 'api.service.com', 'base_path': '/', 'protocol': 'http', 'port': 443, 'version': 'v1'},'healthCheckEndpoint': '/healthcheck', 'auth': {'auth_method': 'no authentication', 'username': 'username', 'password': 'password'}}", "required": true, "schema": { "title": "props", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapTroubleshootAdapter" }, "task": true }, { "name": "iapRunAdapterHealthcheck", "summary": "Runs healthcheck script for adapter", "description": "Runs healthcheck script for adapter", "input": [], "output": { "name": "result", "type": "boolean", "description": "Whether healthcheck passed or failed", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterHealthcheck" }, "task": true }, { "name": "iapRunAdapterConnectivity", "summary": "Runs connectivity check script for adapter", "description": "Runs connectivity check script for adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterConnectivity" }, "task": true }, { "name": "iapRunAdapterBasicGet", "summary": "Runs basicGet script for adapter", "description": "Runs basicGet script for adapter", "input": [ { "name": "maxCalls", "required": false, "type": "number", "info": "How many GET endpoints to test (defaults to 5)", "schema": { "title": "maxCalls", "type": "number", "default": 5 } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing the test results", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRunAdapterBasicGet" }, "task": true }, { "name": "iapMoveAdapterEntitiesToDB", "summary": "Moves entities from an adapter into the Itential Platform database", "description": "Moves entities from an adapter into the Itential Platform database", "input": [], "output": { "name": "res", "type": "object", "description": "A JSON Object containing status, code and the response from the mongo transaction", "schema": { "title": "res", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapMoveAdapterEntitiesToDB" }, "task": true }, { "name": "iapDeactivateTasks", "summary": "Deactivate the inputted tasks", "description": "Deactivate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to deactivate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapDeactivateTasks" }, "task": true }, { "name": "iapActivateTasks", "summary": "Activate the inputted tasks", "description": "activate the inputted tasks", "input": [ { "name": "tasks", "type": "array", "description": "Tasks to activate", "schema": { "title": "tasks", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing success status", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapActivateTasks" }, "task": true }, { "name": "iapPopulateEntityCache", "summary": "Populate the cache for the given entities", "description": "Populate the cache for the given entities", "input": [ { "name": "entityTypes", "type": "array", "info": "the entity type(s) to populate", "required": true, "schema": { "title": "entityTypes", "type": "array" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapPopulateEntityCache" }, "task": true }, { "name": "iapRetrieveEntitiesCache", "summary": "Retrieves data from cache for specified entity type", "description": "Retrieves data from cache for specified entity type", "input": [ { "name": "entityType", "type": "string", "info": "entity of which to retrieve", "required": true, "schema": { "title": "entityType", "type": "string" } }, { "name": "options", "type": "object", "info": "settings of which data to return and how to return it", "required": false, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapRetrieveEntitiesCache" }, "task": true }, { "name": "getDevice", "summary": "Get the Appliance", "description": "Get the Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevice" }, "task": false }, { "name": "getDevicesFiltered", "summary": "Get Appliances that match the filter", "description": "Get Appliances that match the filter", "input": [ { "name": "options", "type": "object", "info": "options - e.g. { 'start': 1, 'limit': 20, 'filter': { 'name': 'abc123' } }", "required": true, "schema": { "title": "options", "type": "object" } } ], "output": { "name": "result", "type": "array", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "array" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getDevicesFiltered" }, "task": false }, { "name": "isAlive", "summary": "Checks the status for the provided Appliance", "description": "Checks the status for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } } ], "output": { "name": "result", "type": "boolean", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "boolean" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/isAlive" }, "task": false }, { "name": "getConfig", "summary": "Gets a config for the provided Appliance", "description": "Gets a config for the provided Appliance", "input": [ { "name": "deviceName", "type": "string", "info": "An Appliance Device Name", "required": true, "schema": { "title": "deviceName", "type": "string" } }, { "name": "format", "type": "string", "info": "The format to be returned - this is ignored as we always return json", "required": false, "schema": { "title": "format", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/getConfig" }, "task": false }, { "name": "iapGetDeviceCount", "summary": "Gets a device count from the system", "description": "Gets a device count from the system", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapGetDeviceCount" }, "task": false }, { "name": "iapExpandedGenericAdapterRequest", "summary": "Makes the requested generic call with additional options", "description": "Makes the requested generic call with additional options via metadata", "input": [ { "name": "metadata", "type": "object", "info": "metadata for the call (optional)", "description": "metadata for the call - allows for many enhancements (optional)", "schema": { "title": "metadata", "type": "object" }, "required": false }, { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": false }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": false }, { "name": "pathVars", "type": "object", "info": "the parameters to be put within the url path (optional)", "description": "the parameters to be put within the url path (optional)", "schema": { "title": "pathVars", "type": "object" }, "required": false }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/iapExpandedGenericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequest", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequest" }, "task": true }, { "name": "genericAdapterRequestNoBasePath", "summary": "Makes the requested generic call", "description": "Makes the requested generic call", "input": [ { "name": "uriPath", "type": "string", "info": "the path of the api call - do not include the host, port, base path or version", "description": "the path of the api call", "schema": { "title": "uriPath", "type": "string" }, "required": true }, { "name": "restMethod", "type": "string", "info": "the rest method (GET, POST, PUT, PATCH, DELETE)", "description": "the rest method (GET, POST, PUT, PATCH, DELETE)", "schema": { "title": "restMethod", "type": "string" }, "required": true }, { "name": "queryData", "type": "object", "info": "the query parameters to be put on the url (optional)", "description": "the query parameters to be put on the url (optional)", "schema": { "title": "queryData", "type": "object" }, "required": false }, { "name": "requestBody", "type": "object", "info": "the payload to be sent with the request (optional)", "description": "the payload to be sent with the request (optional)", "schema": { "title": "requestBody", "type": "object" }, "required": false }, { "name": "addlHeaders", "type": "object", "info": "additional headers to be put on the call (optional)", "description": "additional headers to be put on the call (optional)", "schema": { "title": "addlHeaders", "type": "object" }, "required": false } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/genericAdapterRequestNoBasePath" }, "task": true }, { "name": "iapRunAdapterLint", "summary": "Run the adapter lint script to return the results", "description": "Run the adapter lint script to return the results", "input": [], "output": { "name": "result", "type": "string", "description": "A string containing the run results", "schema": { "title": "result", "type": "string" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterLint" }, "task": true }, { "name": "iapRunAdapterTests", "summary": "Run the adapter test scripts (baseunit and unit) to return the results", "description": "Run the adapter test scripts (baseunit and unit) to return the results", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapRunAdapterTests" }, "task": true }, { "name": "iapGetAdapterInventory", "summary": "Provide inventory information abbout the adapter", "description": "Provide inventory information abbout the adapter", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/iapGetAdapterInventory" }, "task": true }, { "name": "requestaSessionToken", "summary": "Request a Session Token", "description": "For accessing APIs in the system, there are these methods:\n\n1. Using Basic Authentication\n2. Using a Session Token\n\nThe following API command creates a session token. Subsequent requests to the system can use the obtained session token for authentication. A new token is necessary if the token expires (see below).\n\n\nRequest Payload Details\n\n\n| Attribute | Description |\n| --- | --- |\n| username | **Required:** The unique username of the user. |\n| password | **Required:** The password of the user...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"username\": \"string\", \"password\": \"string\"}", "required": true, "schema": { "title": "RequestaSessionTokenRequest", "required": [ "username", "password" ], "type": "object", "properties": { "username": { "type": "string" }, "password": { "type": "string" } }, "example": { "username": "{{basic-auth-username}}", "password": "{{basic-auth-password}}" } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/requestaSessionToken" }, "task": true }, { "name": "releaseaSessionToken", "summary": "Release a Session Token", "description": "Release a token so that it may no longer be used to authenticate requests.\n\n| Attribute | Description |\n| --- | --- |\n| token | **Required:** The API token to be released. |", "input": [ { "name": "body", "type": "object", "info": ": {\"token\": \"string\"}", "required": true, "schema": { "title": "ReleaseaSessionTokenRequest", "required": [ "token" ], "type": "object", "properties": { "token": { "type": "string" } }, "example": { "token": "f3302885cff780987cebfaa6be0ad283619b7a3be42df4f4546fbd47b9ae2a6b" } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/releaseaSessionToken" }, "task": true }, { "name": "modifyingPasswordSecuritySetting", "summary": "Modifying Password Security Setting", "description": "Password Security Setting API is used by administators to modify password attributes like format, validity, etc. This function is performed by the ADMIN user.\n\n| Attribute | Description |\n| --- | --- |\n| expiration-mode | Describes how to handle the expiration date on the newly created account. Possible values : expire-now: Create the account as already expired expire-policy: Set the expiration date according to configured system policy expire-never: Create an account which wil...(description truncated)", "input": [ { "name": "body", "type": "object", "info": ": {\"password-expiry-days\": 123, \"expiration-mode\": \"string\"}", "required": true, "schema": { "title": "ModifyingPasswordSecuritySettingRequest", "required": [ "password-expiry-days", "expiration-mode" ], "type": "object", "properties": { "password-expiry-days": { "type": "integer" }, "expiration-mode": { "type": "string" } }, "example": { "password-expiry-days": 90, "expiration-mode": "expire-now" } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/modifyingPasswordSecuritySetting" }, "task": true }, { "name": "retrievePasswordSecuritySetting", "summary": "Retrieve Password Security Setting", "description": "This API is used to retrieve password security settings. This function is performed by ADMIN user.\n\nFollowing table describes the attributes returned in the response.\n\n| Attribute | Description |\n| --- | --- |\n| expiration-mode | Describes how to handle the expiration date on the newly created account. Possible values : expire-now: Create the account as already expired expire-policy: Set the expiration date according to configured system policy expire-never: Create an account w...(description truncated)", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/retrievePasswordSecuritySetting" }, "task": true }, { "name": "createGroup", "summary": "Create Group", "description": "Create a new group by providing a unique group name and selecting permissions for the users. The name of the group is passed in via the URL and the body.\n\n| Attribute | Description |\n| --- | --- |\n| name | **Required:** A unique name of this group. |\n| permissions | A list of APIs which are permissible to this group. To see a complete list of API permissions, use the `Get Group` API call below to get the permissions for the `super-user` group. |\n| domains | A list of domains this group may acces...(description truncated)", "input": [ { "name": "group", "type": "string", "description": "Name of a group", "schema": { "title": "group", "type": "string" } }, { "name": "body", "type": "object", "info": ": {\"name\": \"string\", \"permissions\": \"array\", \"domains\": \"array\"}", "required": true, "schema": { "title": "CreateGroupRequest", "required": [ "name", "permissions", "domains" ], "type": "object", "properties": { "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "" }, "domains": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "name": "read-only", "permissions": [ "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions" ], "domains": [] } } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "POST", "path": "/createGroup" }, "task": true }, { "name": "deleteGroup", "summary": "Delete Group", "description": "Delete an existing group by providing the group name by providing the group name in the URL parameter.", "input": [ { "name": "group", "type": "string", "description": "Name of a group", "schema": { "title": "group", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "title": "result", "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/deleteGroup" }, "task": true }, { "name": "getGroup", "summary": "Get Group", "description": "This API is used to retrieve a given user group and their associated permissions.\n\n| Attribute | Description |\n| --- | --- |\n| domains | A list of domains this group may access. |\n| name | The unique name of this group. |\n| permissions | A list of APIs which are permissible to this group. |", "input": [ { "name": "group", "type": "string", "description": "Name of a group", "schema": { "title": "group", "type": "string" } } ], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "object" } }, "roles": [ "admin" ], "route": { "verb": "GET", "path": "/getGroup" }, "task": true }, { "name": "getAllGroups", "summary": "Get All Groups", "description": "This API is used to retrieve a list of user groups and their associated permissions.\n\n| Attribute | Description |\n| --- | --- |\n| domains | A list of domains this group may access. |\n| name | The unique name of this group. |\n| permissions | A list of APIs which are permissible to this group. |", "input": [], "output": { "name": "result", "type": "object", "description": "A JSON Object containing status, code and the result", "schema": { "type": "array", "items": { "title": "GetAllGroups-Success", "required": [ "domains", "name", "permissions" ], "type": "object", "properties": { "domains": { "type": "array", "items": { "type": "string" }, "description": "" }, "name": { "type": "string" }, "permissions": { "type": "array", "items": { "type": "string" }, "description": "" } }, "example": { "domains": [], "name": "activate-device-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices", "adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev", "adtran-cloud-platform-labels:read-labels", "adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls", "adtran-auth-permission:all", "adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int", "adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md", "adtran-cloud-platform-profiles:read-profile", "adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces", "adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types", "adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains", "adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number", "adtran-cloud-platform-uiworkflow-profiles:read-profile" ] } }, "description": "", "example": [ { "domains": [], "name": "activate-device-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices", "adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev", "adtran-cloud-platform-labels:read-labels", "adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls", "adtran-auth-permission:all", "adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int", "adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md", "adtran-cloud-platform-profiles:read-profile", "adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces", "adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types", "adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains", "adtran-cloud-platform-uiworkflow-part-numbers:read-uiworkflow-part-number", "adtran-cloud-platform-uiworkflow-profiles:read-profile" ] }, { "domains": [], "name": "activate-interface-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interfaces", "adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int", "adtran-auth-permission:all", "adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev", "adtran-cloud-platform-labels:read-labels", "adtran-cloud-platform-profiles:read-profile", "adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles", "adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls", "adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices", "adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-interface-resources", "adtran-cloud-platform-uiworkflow-interfaces:filter-uiworkflow-physical-resources", "adtran-cloud-platform-uiworkflow-interfaces:read-uiworkflow-interface-type", "adtran-cloud-platform-uiworkflow-profiles:read-profile" ] }, { "domains": [], "name": "activate-job-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-uiworkflow-jobs:read-job", "adtran-cloud-platform-jobs:read-adtn-cld-pfrm-job", "adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev", "adtran-cloud-platform-profiles:read-profile", "adtran-cloud-platform-uiworkflow-devices:read-uiworkflow-devices", "adtran-cloud-platform-uiworkflow-jobs:get-job-context", "adtran-cloud-platform-uiworkflow-jobs:read-action", "adtran-cloud-platform-uiworkflow-jobs:read-trigger", "adtran-cloud-platform-uiworkflow-profiles:read-profile" ] }, { "domains": [], "name": "activate-management-domain-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domains", "adtran-cloud-platform-management-domains:read-adtn-cld-pfrm-md", "adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev", "adtran-auth-permission:all", "adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls", "adtran-cloud-platform-uiworkflow-management-domains:read-uiworkflow-management-domain-types" ] }, { "domains": [], "name": "activate-profile-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-labels:read-labels", "adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls", "adtran-auth-permission:all", "adtran-cloud-platform-profiles:config-profile", "adtran-cloud-platform-hardware:read-profile", "adtran-yang-datastore:read-yang-model", "adtran-yang-datastore:write-yang-model" ] }, { "domains": [], "name": "activate-profile-vector-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow-profiles:read-profile", "adtran-cloud-platform-profiles:read-profile", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-labels:read-labels", "adtran-yang-datastore:read-yang-model", "adtran-yang-datastore:write-yang-model", "adtran-cloud-platform-profiles:config-profile", "adtran-auth-permission:all", "adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls", "adtran-cloud-platform-interfaces:read-adtn-cld-pfrm-int", "adtran-cloud-platform-devices:read-adtn-cld-pfrm-dev", "adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers", "adtran-cloud-platform-uiworkflow-bundles:read-uiworkflow-bundles", "adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr", "adtran-cloud-platform-profiles:config-profile" ] }, { "domains": [], "name": "activate-provider-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-uiworkflow-services:read-uiworkflow-content-providers", "adtran-captive-portal-content-providers:read-content-provider", "adtran-auth-permission:all" ] }, { "domains": [], "name": "activate-server-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-cloud-platform-uiworkflow-servers:read-uiworkflow-servers", "adtran-cloud-platform-servers:read-adtn-cld-pfrm-srvr", "adtran-cloud-platform-labels:read-labels", "adtran-cloud-platform-uiworkflow-credentials:read-adtn-cld-pfrm-uiw-crdls", "adtran-auth-permission:all" ] }, { "domains": [], "name": "activate-service-user", "permissions": [ "adtran-cloud-platform-search:execute-search", "adtran-captive-portal-services:activate-service", "adtran-captive-portal-services:deactivate-service", "adtran-captive-portal-service-transition:read-service-transitions", "adtran-cloud-platform-uiworkflow-services:read-uiworkflow-services", "adtran-cloud-platform-services:read-service", "adtran-cloud-platform-uiworkflow:read-uiworkflow-catalog", "adtran-auth-permission:all", "adtran-cloud-platform-uiworkflow:run-uiworkflow-activate", "adtran-cloud-platform-uiworkflow:run-uiworkflow-deactivate", "adtran-cloud-platform-uiworkflow:read-uiworkflow-transitions", "adtran-yang-datastor